XxxxQUERY

This function is called by the IRE to determine the capabilities of the control and to receive information critical to its successful use within the IRE. The USERINFO structure is completed through this function where the IRE will pass the address of the structure to the function.

Syntax

BOOL EXPENTRY XxxxQuery (PUSERINFO pUserInfo);

Parameters

pUserInfo (PUSERINFO) - output

The address of the USERINFO structure allocated within the IRE. The information that is placed in the structure is as follows:

pUserInfo->ulMajor = 1UL;
pUserInfo->ulMinor = 0UL;
pUserInfo->cTypes = 1UL;
strcpy(pUserInfo->szAuthor, "Author");
strcpy(pUserInfo->szClassname, "Class name");
strcpy(pUserInfo->szName, "Common Name");
pUserInfo->utDefined[0].cx = 50L;
pUserInfo->utDefined[0].cy = 12L;
pUserInfo->utDefined[0].flStyle = 0UL;
pUserInfo->utDefined[0].idDlg = dialog id;
pUserInfo->utDefined[0].ulType = UTYPE_PRIVATE;
pUserInfo->utDefined[0].cCtlData = 20UL;
pUserInfo->utDefined[0].cMasks = 2UL;
pUserInfo->utDefined[0].cMaxText = 5UL;
pUserInfo->utDefined[0].flStyleType = STYLETYPE_BITFLAGS;
pUserInfo->utDefined[0].stMasks[0].flStyleMask = 0x0001UL;
pUserInfo->utDefined[0].stMasks[0].idStyle = String id;
pUserInfo->utDefined[0].stMasks[1].flStyleMask = 0x0002UL;
pUserInfo->utDefined[0].stMasks[1].idStyle = String id;
strcpy(pUserInfo->utDefined[0].szDescription, "Description"); 

Returns

rc (BOOL) - returns

A flag indicating successful completion.

TRUE Successful completion of the structure.
FALSE The structure was not completed, and the control should not be used.


Control Extensions


PMCX Construction
PMCX Architecture
How PMCX Works