GetTokenLevel
(Control Token Manager)
Description: | Checks if a token is applied directly to the tag or (optional) the tag's ancestors, and if so, returns the token's level. |
Returns: |
Numeric (Invalid if no token is found) |
Usage: | Script or steady state. |
Function Groups: |
(Control Token Manager) |
Related to: |
CanControl (Control Token Manager) | CanDenyTokenRequest | CanGrantTokenRequest | CanReleaseToken | CanRequestToken | DenyTokenRequest | GetToken (Control Lock Module) | GetTokenLevel | GrantTokenRequest | ReleaseToken | RequestToken | |
Format: | \ControlTokenManager.GetTokenLevel(TagID[, IncludeAncestry, Snapshot]) |
Parameters: |
TagID |
Required text. The UniqueIDof the tag. |
IncludeAncestry |
Optional Boolean. Set TRUE to search the tag's ancestry. Defaults to TRUE. |
Snapshot |
Optional Boolean. Set TRUE if calling this function in script. Defaults to FALSE. |
Comments: |