Retrieves the context identifier by a defined name. You can define a name for a context identifier by using the CtxSetName function for that context.
|
Syntax:
|
CtxGetId(context name)
|
Parameters:
|
context name: A string value representing the context name.
|
Returns:
|
A numeric value of a context identifier corresponding to a specified name. The maximum number of digits is 18.
|
Example:
|
CtxGetId('Dispatcher') returns the numeric identifier for a context named Dispatcher.
|
Note:
|
-
If the context name parameter is empty, the returned context identifier will be for the current context. If no context is found, a value of 0 will be returned.
-
This is useful for functions that require an ID and not a name.
|
See also:
|
CtxGetName
The Online and Rich Client Samples projects (program ES01 and RES01)
|