CheckIn
You can use this function for Optiva Workflows.
Purpose
This function locks an Optiva object and you cannot modify unless a user checkout the object.
Syntax
int CheckIn(string objSymbol, string objKey);
Return Value
If the code is successful, a value one (1) is displayed and zero (0) if failed.
Arguments
| Part | Description |
|---|---|
objSymbol |
The object type or current object type of the data.
Note: Use empty quotation marks to indicate the current symbol of the workflow.
|
objkey |
The object key or current object key of the data.
Note: Use empty quotation marks to indicate the current object of the workflow.
|
Description
Check-in unlocks an object. It returns a value of 0 or 1.
| Value | |
|---|---|
| 0 | Did not check in the object. May already be checked in. |
| 1 | Checked in the object. |
Examples
This example checks in the current object from which the Workflow was launched
Dim rc As Integer = CheckIn("","")
If rc = 1 Then
MessageList(_OBJECTSYMBOL & " " & _OBJECTKEY & " checked in.")
Else
MessageList(_OBJECTSYMBOL & " " & _OBJECTKEY & " not checked in.")
End if
This example checks in a specific object
Dim rc As Integer = CheckIn("FORMULA","FS-0010\0001")
If rc = 1 Then
MessageList("Formula FS-0010\0001 has been checked in.")
Else
MessageList("Formula FS-0010\0001 could not be checked in.")
End if
Locks the formula FS-0010\0001
CheckIn("FORMULA","FS-0010\0001")
CheckIn()Locks the objectkey upon which the workflow is launched.
CheckIn()