XPGetWidgetDescriptor

XPGetWidgetDescriptor

WIDGET_API int        XPGetWidgetDescriptor(
                         XPWidgetID           inWidget,
                         char *               outDescriptor,
                         int                  inMaxDescLength);

This routine returns the widget’s descriptor. Pass in the length of the buffer you are going to receive the descriptor in. The descriptor will be null terminated for you. This routine returns the length of the actual descriptor; if you pass NULL for outDescriptor, you can get the descriptor’s length without getting its text. If the length of the descriptor exceeds your buffer length, the buffer will not be null terminated (this routine has ‘strncpy’ semantics).