L_AnnGetUserMode
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetUserMode(hObject, puMode)
HANNOBJECT hObject; |
/* handle to the annotation object */ |
L_UINT *puMode; |
/* address of the variable to be updated */ |
Gets a value indicating the user mode of the specified annotation object. The user mode can be for interactive design of an annotation object or for run-time use.
Parameter |
Description |
|
hObject |
Handle to the annotation object. |
|
puMode |
Address of the variable to be updated with the annotation object's current user mode. Possible values for the user mode are: |
|
|
Value |
Meaning |
|
ANNUSER_DESIGN |
[0] Design mode. Used for creating objects. |
|
ANNUSER_RUN |
[1] Run mode. Used for viewing and/or activating objects. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, you must declare a variable of data type L_UINT. Then, pass the address of the variable in the puMode parameter. This function will update the variable with the annotation object's user mode constant.
Required DLLs and Libraries
LTANN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Functions: |
|
Topics: |
|
|
|
|
|
|
|
|
Example
This example gets the current user mode and assigns it to a global variable.
L_INT AnnGetUserModeExample(HANNOBJECT hContainer, /* Container annotation object */ L_UINT nAnnUserMode) /* Automation user mode, design or run */ { L_INT nRet; L_TCHAR szMessage[80]; nRet = L_AnnGetUserMode(hContainer, &nAnnUserMode); if(nRet != SUCCESS) return nRet; wsprintf(szMessage, TEXT("User mode %d"), nAnnUserMode); MessageBox(NULL, szMessage, TEXT("Notice"), MB_OK); return SUCCESS; }