L_AnnGetHyperlinkLen
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetHyperlinkLen(hObject, puLen)
|
HANNOBJECT hObject; |
/* handle of the annotation object */ |
|
L_SIZE_T *puLen; |
/* address of the variable to be updated */ |
Gets the length of the specified annotation object's hyperlink string. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
hObject |
Handle of the annotation object from which to retrieve the length of the hyperlink sting |
|
puLen |
Address of the variable to be updated with the length of the hyperlink string. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Only objects with a hyperlink of type ANNLINK_RUN or ANNLINK_WEBPAGE have a hyperlink string associated with them. To see what the hyperlink string of an object is, you must first call this function and get the string length, allocate a buffer large enough to store the string and the NULL at the end, and then call L_AnnGetHyperlink. Note that the length does NOT account for the null at the end of the string.
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. |
Platforms
Windows 2000 / XP/Vista.
See Also
|
Functions: |
L_AnnSetHyperlinkMenuEnable, L_AnnGetHyperlinkMenuEnable, L_AnnSetHyperlink, L_AnnGetHyperlink |
|
Topics |
|
|
|
|
|
|
Example
For an example, refer to L_AnnGetHyperlink. For complete sample code, refer to the Annotate example.