Page.getLockStatus (Method)
Returns a structure whose members contain page lock information. This includes the lock's type, who owns the lock, and so on.
Returns:
Page_GetLockStatus_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| LockedOnDate | DateTime_EmptyString | The date and time the lock was made, or an empty string if no lock exists. |
| LockType | LockType_EmptyString | The lock's type which is 'Temporary', 'Permanent', or an empty string. An empty string indicates that no lock exists. |
| UserFullName | Person_FirstNameMiddleNameLastName_EmptyString | The 'Firstname middlename Lastname' of the user holding the lock. CommonSpot returns an empty string if the page is not locked. |
| UserID | UserID_0 | The user ID of the user holding the lock or 0 if no lock exists. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_NonBaseTemplate | Required | A page's ID. |
Context:
| License Requirements | None |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
None