GetHyperLinkCtrlAttribute

Download PDF

int GetHyperLinkCtrlAttribute (int panel, int control, int attribute, void *attributeValue);

Purpose

Gets the specified hyperlink control attribute.

Input
Name	Type	Description
panel	int	The handle of the panel for the hyperlink control.
control	int	The ID of the hyperlink control.
attribute	int	The hyperlink control attribute value to obtain. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. LabWindows/CVI dims the attributes whose values are not available. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.
Output
Name	Type	Description
attributeValue	void *	The value of the specified hyperlink control attribute. If the attribute shown in this control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants.

Name	Type	Description
status	int	Return value indicating whether the function was successful. A negative number indicates that an error occurred. Call the GetGeneralErrorString toolbox function to get a descriptive error message.

Library: HyperLink Control

Include file: custctrl\hyperlinkctrl.h

LabWindows/CVI compatibility: LabWindows/CVI 9.0 and later