L_AnnGetHyperlinkLen

Summary

Gets the length of the specified annotation object's hyperlink string.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetHyperlinkLen(hObject, puLen)

Parameters

HANNOBJECT hObject

Handle of the annotation object from which to retrieve the length of the hyperlink sting

L_SIZE_T *puLen

Address of the variable to be updated with the length of the hyperlink string.

Returns

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to L_AnnGetHyperlink.
For a complete sample code, refer to the \Examples\Annotation\C\Annotate demo.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.