Function CheckInEx

With this function you can check in a document again that you had previously received from the archive via CheckOut. Please note that you must not change the file name, as this contains the ID for the archive used and the object number. Under ELOprofessional 3.0, the CheckIn command leads to a request of the version number and a comment. You can suppress this request by using the CheckInEx command, this information is sent as parameters instead.

int CheckIn (AnsiString FileName)

int CheckInEx (AnsiString FileName, AnsiString sComment, AnsiString sVersion) Parameters:

FileName : Name of file to be checked in

sComment : Comment on the new document version sVersion : Version number

Return values:

>0: ObjectId of the document checked in -100: No work area active

-1..-10 CIO_LockError, CIO_PathError, CIO_CopyError, CIO_ExecError, CIO_UknError, CIO_NoDocument, CIO_ModeError,

CIO_UserAbort, CIO_ArchiveError, CIO_ReadOnly Example:

function CryptIt(ObjId, key circuit) CryptIt=1

x=Elo.PrepareObjectEx(ObjId, 0, 0) if x<0 then

CryptId=-1 else

if (Elo.ObjFlags and 256)=0 then

Elo.ObjFlags=Elo.ObjFlags or (4096*key circuit) or 256 Elo.UpdateObject

FName=Elo.CheckOut(objid,0) if FName<>"" then

if Elo.CheckInEx(FName,"Automatic encryption","1.0")<0 then CryptId=-3 ' Error during CheckIn

Property CheckInOutFileName (AnsiString)

With this property, you can determine the file name of the document within the "When checking a document in/out" event. If required, the file name can be changed for the "Before checking in" event.

Also see: CheckInOutObjID ActionKey

Property CheckInOutObjID (int)

With this property, you can determine the object ID of the document within the "When checking a document in/out" event.

Also see: CheckInOutFileName ActionKey

Function CheckObjAcl

With the function CheckObjAcl you can check, which access rights you own for a certain object. If the object is already active (e.g. inside of a subject data event or after a PrepareObjectEx), then you assign a 0 to lObjectId.

In this case the current value from the ObjAcl property is used. If the object is not active yet, you can assign the ObjectId as parameter additionally. Then the ACL list of the object is loaded and checked. Since only one property and not the whole object is read out of the database, this way is faster than the combination of PrepareObjectEx (Id…) and CheckObjAcl(0). Of course that applies only then if no other spots of the script require a PrepareObjectEx.

AnsiString CheckObjAcl (int lObjectId) Example:

Set Elo = CreateObject( "ELO.professional" ) Id = Elo.GetEntryId(-1)

' Only ObjectId known:

MsgBox Elo.CheckObjAcl( Id )

if Elo.PrepareObjectEx( Id, 0, 0 ) then ' The Object is already loaded:

MsgBox Elo.CheckObjAcl( 0 ) end if

Parameters:

lObjectId Number of the document to be checked (internal ELO Id) or 0 Return values:

-2 Error while reading the ACL -1 No work area active

>=0 Authorization mask (1: Read, 2: Write, 4: Delete, 8: Edit Document) Available from:

4.00.178

Function CheckOut

With the CheckOut function, you can remove a document from the current archive for editing. After editing was completed, it can then be re-inserted into the archive via the CheckIn function. Please note that you must not change the file name, as this contains the ID for the archive used and the object number.

AnsiString CheckOut (int lObjectId, int iMode) Parameters:

lObjectId Number of the document to be checked out (internal ELO ID) iMode 0 Check out only, do not activate application

1 Check out and activate application without request 2 Check out and activate application after confirmation

Function CheckPage

With the CheckPage function you can check if a separator or empty page exists for the current postbox entry . You can find an example for this command in the prefix.

Int CheckOut (int Mode, int hit ratio)

Parameters:

Mode 1: Empty page control 2: Separator page control (combinations also permitted) Hit ratio 0...999 required hits per thousand.

A value of 970 (default in ELO Client) requires a hit ratio of 97%.

Available from:

3.00.220

Function CheckUpdate

With this function you can decide if a change is to be immediately displayed. Especially for automatic recording of mass data it can save a lot of time if ELO does not display each change. In this case, use an

ELO.CheckUpdate(0) before the run and an ELO.CheckUpdate(1) after the run.

int CheckUpdate (int DoCheck)

Parameters:

DoCheck : 0: no display, 1: Display Return values:

Old status

Also see: EloWindow

Function ClickOn

With this function a mouse click on a dialog component in the ELO main dialog can be simulated. Thus all functions that are available in the menus or toolbar can be requested.

int ClickOn (AnsiString ComponentName)

Parameters:

ComponentName: Name of the dialog component (list of all dialog items see appendix A) Return values:

-5 Function can currently not be requested (dialog component "disabled") -4 Component type is not supported

-3 Component does not have OnClick routine -2 Component not available

-1 Main dialog not active

1 Ok

Also see:

Function CloseActivateDocDlg

With the CloseActivateDocDlg function you can check in a document again onto Elo which was activated from Elo for editing. For this purpose you can choose from the options mode=1: Ok, accept new version and mode=2:

Cancel: Discard changes

int CloseActivateDocDlg (int Mode) Parameters:

Mode 1: Ok, 2: Cancel Return values:

-3 Error when closing the dialog -2 False mode parameter -1 ActivateDocDlg not active

1 Ok

Also see:

Function CollectChildList

With the CollectChildList function you can determine all subsequent nodes for an object ID. The node list is transferred as text string, the individual successor IDs are separated by colons.

AnsiString CollectChildList (int ObjId)

Parameters:

ObjId Node number of the start object Return values:

empty: Error, not specified in more detail else: successor list

Function CollectLinks

With the CollectLinks function you can determine all links for an object ID. The Ids of the linked objects are returned as comma list.

AnsiString CollectLinks (int iObjID, int iMode)

Parameters:

iObjId Object ID of the ELO object

iMode 0

Return values:

"-1" No work area active empty: No links available

else: Successor list (object Ids separated by comma)

Available from:

3.00.378

Function CollectWv

With the CollectWv function, you can collect the reminder dates, workflow tasks and activities of a user. This list is not displayed in ELO, it can only be checked out via the GetListEntry function.

Caution: the temporary internal list is also used by DoInvisibleSearch. If you use both actions in a script, you must check out the complete result list each before a change, otherwise the results are discarded.

int CollectWv (int UserId, AnsiString StartDate, AnsiString EndDate, int Prio) Parameters:

UserId User number (plus 0x40000000 for groups and 0x20000000 for agents) StartDate Start date of report to be collected

EndDate End date of collection area

Prio Priority (only for reminders and activities (1..3)) Return values:

-2: Invalid date -1: No work area active

>=0: Number of found entries Available from:

3.00.394 Example:

Set Elo=CreateObject("ELO.professional") UserId=Elo.ActiveUserId ' only own dates

'UserId=Elo.ActiveUserId + 1073741824 ' with group dates 'UserId=Elo.ActiveUserId + 536870912 ' with agents

'UserId=Elo.ActiveUserId + 1610612736 ' all dates

cnt=Elo.CollectWv(UserId, "22.08.2002", "30.08.2002", 3) for i=0 to cnt-1

msg=msg & Elo.GetListEntry(i) & vbcrlf next

MsgBox msg

Also see: GetListEntry

Property ColorInfo (int)

The ColorInfo property determines the color value of a color definition. This color value is transmitted in RGB style usual for Windows.

Also see: ReadColorInfo WriteColorInfo ColorName

Property ColorName (AnsiString)

The ColorName property determines the color name (short name) of a color definition.

Maximum length: 30 characters

Also see: ReadColorInfo WriteColorInfo ColorInfo

Property ColorNo (int)

The ColorNo property determines the color number of a color definition.

Also see: ReadColorInfo WriteColorInfo ColorName

Function ConfirmWorkflow

With the ConfirmWorkflow function, workflows can be forwarded within the task view of the ELO Client. The name of the node and message text can be set, via the iActivateAll parameter it is controlled whether all succession nodes or only the first are to be activated.

ConfirmWorkflow (int iLine, AnsiString sCaption, AnsiString sComment, int iActivateAll, int iFlags) Parameters:

iLine Line number of the entry within the task list (o-indexed) -1=use currently selected line

sCaption New name of node

empty=leave current name unchanged sComment Message text of node

empty=leave current message text unchanged iActivateAll 1=activate all succession nodes

0=only activate first succession node

iFlags Reserved

Return values:

-7 Error while forwarding the workflow

-6 Line contains workflow entry with group node

-5 Line contains no workflow entry

-4 Invalid line number (for line<>-1) -3 No line selected (for iLine=-1)

-2 Task view not active

-1 No work area active

Available from:

3.00.350

Function ConfirmWorkflowEx

With the ConfirmWorkflow function, any workflows can be forwarded also outside the task view of the ELO Client. The name of the node and message text can be set, via the iActivateAll parameter it is controlled whether all successor nodes or only the first are to be activated.

ConfirmWorkflow (int FlowId, int NodeId, int EloObjId, int Department, AnsiString sCaption, AnsiString sComment, int iActivateAll, int iFlags)

Parameters:

FlowId ELO-internal workflow number NodeId Node ID within the workflow EloObjId Linked ELO document Department Owner of node (not workflow) sCaption New name of node

empty=leave current name unchanged sComment Message text of node

empty=leave current message text unchanged iActivateAll 1=activate all successor nodes

0=only activate first succession node

iFlags Reserved

Return values:

-5 Error during WF forwarding

-4 The given node could not be found -3 The WF is locked by a different user

-2 Database error when reading or writing the WF

-1 No work area active

call Elo.ConfirmWorkflowEx(fields(0), fields(1), fields(2), fields(3),

"Back","", 1,0) Available from:

3.00.380

Function CreateAutoDlg (AnsiString Caption)

Creates an empty dialog with an Ok & Cancel button.

int CreateAutoDlg (AnsiString Caption)

Caption:

Title of dialog Return value:

1 – dialog could be created.

Example:

An empty dialog is displayed.

Elo.CreateAutoDlg ("An empty dialog") Elo.ShowAutoDlg

Available from:

3.00.228

Also see: AddAutoDlgControl ShowAutoDlg GetAutoDlgValue

Function CreateCounter

The CreateCounter function creates a new counter with a start value that can be preset.

int CreateCounter (AnsiString CounterName, int InitialValue) Parameters:

CounterName Name of counter to be created InitialValue Start value

Return values:

-1: Error

1: Ok.

Also see: GetCounterList GetCounter

Function CreateStructure (AnsiString Path, int StartID)

Available from: Ver 3.00.228

This function creates a list with cabinet, folder, registers etc. from current position, or if a separator is set at the start, from cabinet position. Existing paths with the same name are only initialized again if there is a separator at the end of the path.

(AnsiString) CreateStructure (AnsiString Path, int StartID) Path : Path to be created

Individual elements are to be separated by the separator Separator at start Create from cabinet position

StartID is ignored

Separator at end Existing paths are overwritten StartID : Valid values : ObjectID , 0 , negative ObjectID

0 – Creation of path within currently selected object

A negative StartID causes the creation within the object, a positive on the same level.

The separator at the start of a path has precedence over the StartID. (StartID is ignored) Return values:

List of ObjectIDs of created elements separated by separator (235¿252¿22) -5 – No entry selected

-4 – Empty field name

-3 – No valid start position given -2 – No work area active

-1 – Too many objects (archive depth is exceeded) Example:

Creates a cabinet, folder and tab. Start position is the filing cabinet level.

ELO. CreateStructure ("¿My_Cabinet¿My_Folder¿My_Tab",0) Creates tab with sub tab or folder with tab or cabinet with folder Depending on the current position in the archive

ELO. CreateStructure ("123¿222",0)

Creates tab with sub tab or folder with tab or cabinet with folder At same level of given object

ELO. CreateStructure ("123¿222"0.2345)

Creates tab with sub tab or folder with tab or cabinet with folder Within the given object

ELO. CreateStructure ("123¿222",-764)

Also see:

Function CreateViewer

With this function you can create a viewer dataset from an export dataset. For this purpose the ViewerPostbox directory must be prepared under ELOprofessional and a completed export dataset must be available. The target path may already contain a viewer. If the target archive already exists, the datasets are added to this archive. Up to 4 archives may be created in the target area.

Int CreateViewer (AnsiString ExportPath, AnsiString ArcName,AnsiString DestPath) Example:

Set Elo=CreateObject("ELO.professional")

call Elo.CreateViewer("D:\ExportPfad", "test1", "D:\Target path")

Parameters:

ExportPath Directory which contains the export dataset ArcName Viewer archive name

DestPath Target directory for the viewer Return values:

-5: Viewer files could not be copied

-4: Postbox directory in the target path could not be created -3: Directory structure in the target path could not be created -2: Target path or archive name are missing

-1 : No work area active

1: Ok

Available from:

3.00.354

Function DateToInt (AnsiString Date)

This function converts a date text to ELO-internal date format.

int DateToInt (AnsiString Date) Parameters:

Text Date to be converted.

Return values:

0: Invalid date entry

>0: ELO date value Available from:

3.00.196

Also see: IntToDate

Function DeleteFlow(int, int)

Removes an ELO Workflow without transferring it to the list of completet workflows. Only available for ELO Administrators.

int DeleteFlow( int FlowId, int ObjId ) Parametes:

FlowId: Workflow Id

ObjId: Attached ELO Object Return values:

-1: No work area active -2: No deletion access rights -3: Database delete error 1: Workflow deleted Example:

Set ELO = CreateObject("ELO.professional") FlowId = 4711

ObjId = 12345

Result = ELO.DeleteFlow( FlowId, ObjId ) Available from:

5.00.126

Function DeleteMask

Deletes an ELO subject data mask. Before the Deleting operation it will be checked, if there are still entries with this mask in the archive or with the deleted but not yet permanently removed objects. If there are still entries, the command is cancelled with an error an in the TextParam property a list is located with the first 16 Object-Ids which use this mask.

int DeleteMask (int MaskNo)

Parameters:

MaskNo: Number of the mask to be deleted Return values:

-3: Database error while deleting

-2: There are still entries for this mask number -1: No work area active

1: Ok

Example:

Set ELO = CreateObject("ELO.professional")

MaskNo = ELO.LookupMaskName( "ThisMaskWillBeDeleted" ) if MaskNo > 0 then Objects: " & ELO.TextParam

end if else

MsgBox "Mask not found"

end if

Available from:

4.00.210

Function DebugOut

This function sends a text to the Elo Debug window.

void DebugOut (AnsiString Text) Parameters:

Text Text to be issued, sent to the Debug window together with time.

Return values:

None

Also see:

Function DeleteObj

Deletes an Elo entry, pre-defined by the ObjectID. If a cabinet, folder or tab is concerned, all sub-entries are deleted as well.

int DeleteObj (int ObjectId)

Parameters:

ObjectId: Number of entry to be deleted Return values:

-3: Insufficient authorization for deletion -2: Error when deleting

-1: No work area active

1: Ok

Also see: PrepareObj UpdateObj

Function DeleteProjectOptions

Deletes all option entries of a project in the defaults for the activities. Possibly existing project activities are not deleted, however, and can still be displayed and listed.

You can also selectively delete a single entry. In this case, instead of the project name you must enter a string containing name, major no., minor no. and value, separated by the normal delimiter (¿). The field value can be left empty, the major and minor numbers can be set to 0 if they are not known. However, this deletes entire groups, so be careful when using this option.

int DeleteProjectOptions (AnsiString ProjectName) Parameters:

ProjectName: Name of project or project entry to be deleted.

Return values:

-7: Project entry was not available -6: Project entry not properly formatted -5: Project was not available

-3: Error when deleting

-2: Missing or invalid project name -1: No work area active

MsgBox "You have no authorization for editing the data"

case else

MsgBox "Error : " & res end select

end if

if res>0 then

call Elo.InsertProjectOptions("ELO_SYSTEM", 1, 0, "TEST") call Elo.InsertProjectOptions("TEST" , 10, 1, "Contact") call Elo.InsertProjectOptions("TEST" , 10, 4, "Meier") call Elo.InsertProjectOptions("TEST" , 10, 2, "Müller") call Elo.InsertProjectOptions("TEST" , 10, 3, "Schulze") end if

Available from:

3.00.360

Also see: InsertProjectOption

Function DeleteSwl

Deletes a subtree of a keyword list. Each entry contains a unique two letter level information: AA, AB, AC .. ZZ per level. The root level starts with a dot. „.AAABAC“ starts at the base with the first entry, within this with the second subentry, within this selects the third subentry. Deleting an entry will automatically delete all subentries.

The group parameter is connected to the group entry in the keywording form.

int DeleteSwl( AnsiString Group, AnsiString Parent)

Parameters:

Group Selects a keyword list Parent Path of the subtree Return values:

-1: no work area active -2: error when writing

-3: invalid or unknown parent path 1: Ok

Example ...

Set Elo=CreateObject("ELO.professional") call Elo.DeleteSwl( "THM", "." )

MsgBox Elo.AddSw( "THM", ".", "1" ) MsgBox Elo.AddSw( "THM", ".AA", "1.1" ) MsgBox Elo.AddSw( "THM", ".AA", "1.2" ) MsgBox Elo.AddSw( "THM", ".AA", "1.3" ) MsgBox Elo.AddSw( "THM", ".", "2" ) MsgBox Elo.AddSw( "THM", ".", "3" ) MsgBox Elo.ReadSwl( "THM", ".", " - " ) MsgBox Elo.ReadSwl( "THM", ".AA", " - " ) call Elo.UpdateSw( "THM", ".AB", "2a" ) MsgBox Elo.ReadSwl( "THM", ".", " - " ) ...

Available from 5.00.066

Function DeleteWv

Deletes a reminder date (determined by parameter WvIdent). When deleting a date, the owner must also be indicated, if you set a –1 here your own EloUserId is used.

int DeleteWv (int WvId, int UserOwner)

Parameters:

WvId: Number of date to be deleted UserOwner: Owner of date

Return values:

-2: Error when deleting -1: No work area active

1: Ok

Also see: ReadWv WriteWv WvIdent WvParent WvUserOwner WvUserFrom WvDate WvCreateDate WvPrio WvParentType WvShort WvDesc

Function DeleteWvLine

With this function an entry can be hidden within the display of the reminder dates. The associated reminder entry is not deleted.

int DeleteWvLine (int LineNo)

Parameters:

LineNo: Line number of entry to be hidden Return values:

-1: No work area active 0: Wrong line number

1: Ok

Also see: WriteWv DeleteWv WvIdent WvParent WvUserOwner WvUserFrom WvDate WvCreateDate WvPrio WvParentType WvShort WvDesc

Property DelOutlookName (AnsiString)

Available from:

This property indicates the reminder’s name of the person (group) to be deleted. It is used when the name of the person (group) to which the reminder is addressed is changed in ELO, so that the entry can be removed.

Also see: OutlookName

Function DoCheckInOut

This function opens a dialog for checking documents in and out.

int DoCheckInOut (int hwndParent, AnsiString DlgTitle, AnsiString Short, AnsiString Desc, AnsiString XDate, AnsiString FileName,int Ctrl, int Minimize)

Parameters:

hwndParent Windows window handle of superordinated window DlgTitle Title of dialog to be opened.

Short Short name (check in for new document) Desc Additional text (check in for new document) XDate Document date (check in for new document) FileName File name of file

Ctrl -1 new document

0 Check out

>0 Check in

Minimize Minimize <>0 for ELO Client Return values:

-1 No work area active or Storage in postbox

0 Cancel

>0 Object Id

Also see: DoCheckInOut2

Function DoCheckInOut2

This function opens a dialog for checking documents in and out.

int DoCheckInOut 2(int hwndParent, AnsiString sDlgTitle, AnsiString sShort, AnsiString sDesc, AnsiString sXDate, AnsiString sFilterExt, AnsiString& sFileName, int nMinimize)

Parameters:

hwndParent: Windows window handle of superordinated window sDlgTitle: Title of dialog to be opened.

sShort: Short name (check in for new document) sDesc: Additional text (check in for new document) sXDate: Document date (check in for new document)

sFilterExt: File endings available for selection. Format expl: "Word documents

(*.doc;*.dot;*.txt)|*.doc;*.dot;*.txt|Excel documents (*.xxx)|*.xls;*.txt". Format entry for "All documents|*:*" is entered automatically

nMinimize: minimize <>0 for ELO Client Return values:

0 ... Cancel

1 ... New document saved 2 ... Document checked in

3 ... Document checked out of archive 4 ... Edit already checked out document

Function DoCheckInOut3

This function opens a dialog to check documents in/out.

int DoCheckInOut3 (int hwndParent, AnsiString sDlgTitle, AnsiString sShort, AnsiString sDesc, AnsiString sXDate, AnsiString sFilterExt, AnsiString& sFileName, int nMinimize, int iFlags, AnsiString sInfo)

Parameters:

hwndParent: Windows window handle of superordinated window sDlgTitle: Title of dialog to be opened.

sShort: Short name (check in for new document) sDesc: Additional text (check in for new document) sXDate: Document date (check in for new document)

sFilterExt: File endings available for selection. Format expl: "Word documents

(*.doc;*.dot;*.txt)|*.doc;*.dot;*.txt|Excel documents (*.xxx)|*.xls;*.txt". Format entry for "All documents|*:*" is entered automatically

nMinimize: Minimize <>0 for ELO Client

iFlags: Bit 0 set: Subject data information will be assumed from the internal, with

In document ELO OLE Automation Interface Description UK (Page 82-121)