dms.CheckOutDocument
This job checks out the specified document. The document is marked as checked out in the database. The document itself must then be retrieved from the server using the job std.StoreInCache.
If a document without a file (reference-only document) is checked out, error -1041 is returned with the error text "The document cannot be checked out because it has no pages".
|
1. Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
INT |
Yes |
1 = the document will be checked out as 'external', otherwise 0 |
|
INT |
Yes |
Type of the cabinet |
|
INT |
Yes |
Type of the object |
|
INT |
Yes |
ID of the document |
2. Output Parameters
| Name | Type | Dependency | Description |
|---|---|---|---|
|
STRING |
Optional |
If the document is already checked out, the name of the checker-out will be returned |
3. Return Value
(INT): 0 = Job successful, otherwise error code
Complete error list
-
-1038— The document has already been checked out. -
-1041— The document cannot be checked out because it has no pages (reference-only document).