#include “BiAnno.h”
BYTE CALLBACK AnnoUIGetHyperlink( INT_PTR pAnno, LPSTR szHyperLink, int* iLength)
Description
This function retrieves the hyperlink type and the hyperlink string of the last selected annotation object.
Parameters
|
INT_PTR |
PAnno |
Annotation handle |
|
LPSTR |
szHyperlink |
Text of the hyperlink |
|
int* |
iLenght |
Length of the hyperlink text. |
Return value
Type of the hyperlink on success, otherwise 0.
Programming Notes
Available hyperlink types:
A_HYPERLINK_NONE - There is no hyperlink for the object. In this case the hyperlink text is empty.
A_ANNO_MSG - If you click on the object in run mode the defined callback function will be called. In this case the hyperlink text is empty.
A_USER_MSG - If you click on the object in run mode the user defined callback function will be called. In this case the hyperlink text is empty.
A_RUN_EXE - If you click on the object in run mode the specified exe program will be executed. In this case the exe path and name is stored in the hyperlink text.
A_WEB_PAGE - If you click on the object in run mode the specified web page will be displayed. In this case the URL of the page is stored in the hyperlink text.
If the size of the szHyperlink parameter is small for the hyperlink, the function returns 0, and the third parameter will contain the length of the hyperlink in bytes. If the hyperlink type is A_HYPERLINK_NONE, A_ANNO_MSG, A_USER_MSG, the iLength will be zero, and the function returns the type.
Code Example
None