Category Custom user interface, Object ProUILayout

Function ProUILayoutHelptextGet


Description
Get the helptext that will display when the cursor is over the layout component.
Synopsis
#include <ProUILayout.h>
ProErrorProUILayoutHelptextGet(
char* dialog
/* (In)
The name of the dialog that contains layout.
*/
char* component
/* (In)
The name of the layout component.
*/
wchar_t** value
/* (Out)
The helptext. Free this using ProWstringFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_GENERAL_ERRORThe function failed.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.

Manual References:

  1. User Interface: Dialogs: Layout Attributes