PFNPROPSHEETCALLBACK callback function (prsht.h)

An application-defined callback function that the system calls when the property sheet is being created and initialized.

Syntax

PFNPROPSHEETCALLBACK Pfnpropsheetcallback;

int Pfnpropsheetcallback(
  HWND unnamedParam1,
  UINT unnamedParam2,
  LPARAM unnamedParam3
)
{...}

Parameters

unnamedParam1

Type: HWND

Handle to the property sheet. This parameter is typically called hWnd.

unnamedParam2

Type: UINT

Message being received. This parameter is typically called uMsg.

This parameter is one of the following values.

unnamedParam3

Type: LPARAM

Additional information about the message. This parameter is typically called lParam.

The meaning of this value depends on the uMsg (unnamedParam2) parameter:

• If uMsg is PSCB_INITIALIZED or PSCB_BUTTONPRESSED, the value of this parameter is zero.

• If uMsg is PSCB_PRECREATE, then this parameter will be a pointer to either a DLGTEMPLATE or DLGTEMPLATEEX structure describing the property sheet dialog box. Test the signature of the structure to determine the type. If signature is equal to 0xFFFF then the structure is an extended dialog template, otherwise the structure is a standard dialog template. The following example demonstrates how to do this.

  if (uMsg == PSCB_PRECREATE) 
  {
       if (lParam)
       {
            DLGTEMPLATE *pDlgTemplate;
            DLGTEMPLATEEX *pDlgTemplateEx;
  
            pDlgTemplateEx = (DLGTEMPLATEEX *)lParam;  
            if (pDlgTemplateEx->signature == 0xFFFF)
            {
                 // pDlgTemplateEx points to an extended  
                 // dialog template structure.
            }
            else
            {
                 // This is a standard dialog template
                 //  structure.
                 pDlgTemplate = (DLGTEMPLATE *)lParam;
            }
       }    
  }
  

Return value

Type: int

Returns zero.

Remarks

To enable a PropSheetProc callback function, use the PROPSHEETHEADER structure when you call the PropertySheet function to create the property sheet. Use the pfnCallback member to specify an address of the callback function, and set the PSP_USECALLBACK flag in the dwFlags member.

PropSheetProc is a placeholder for the application-defined function name. The PFNPROPSHEETCALLBACK type is the address of a PropSheetProc callback function.

Requirements