L_AnnGetHyperlinkLen - Raster Imaging C API Help

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.

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

Win32, x64.

See Also

Functions:

L_AnnSetHyperlinkMenuEnable, L_AnnGetHyperlinkMenuEnable, L_AnnSetHyperlink, L_AnnGetHyperlink

Topics

Annotation Functions (Document/Medical only): Hyperlinks

 

Implementing an Automated Annotation Program

 

Obtaining Annotation Object Information

Example

For an example, refer to L_AnnGetHyperlink. For complete sample code, refer to the Annotate example.

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help