CPSFUNC_SET_DMPUB_HIDEBITS function

The CPSFUNC_SET_DMPUB_HIDEBITS function code causes the ComPropSheet function to "hide" a specified set of document property options, so that they are not displayed.

Syntax

LONG_PTR ComPropSheet(
   HANDLE hComPropSheet,
   UINT   Function,
   LPARAM lParam1,
   LPARAM lParam2
);

Parameters

  • hComPropSheet
    Group parent handle.

  • Function
    Caller sets this function code parameter to CPSFUNC_SET_DMPUB_HIDEBITS when it calls ComPropSheet to "hide" a specified set of document property options.

  • lParam1
    Pointer to a bit array that indicates the options to be hidden. This array must be created using the MAKE_DMPUB_HIDEBIT(DMPub) macro, where DMPub is the OR-combination of one or more DMPUB_-prefixed constants. The DMPUB_-prefixed constants are listed in the description of the OPTITEM structure. The macro and constants are defined in Compstui.h.

  • lParam2
    Not used, must be zero.

Return value

If the operation is successful, the ComPropSheet function returns the value specified for lParam1; otherwise it returns zero.

Remarks

You can use the CPSFUNC_SET_DMPUB_HIDEBITS function code if you want to define OPTITEM structures for one or more document property sheet options, but you do not want the options to be user-modifiable. The property sheet page must be defined using the COMPROPSHEETUI structure, and the structure's pDlgPage member must be CPSUI_PDLGPAGE_DOCPROP or CPSUI_PDLGPAGE_ADVDOCPROP.

If you use the CPSFUNC_SET_DMPUB_HIDEBITS function code, it must be specified to ComPropSheet before the CPSFUNC_ADD_PCOMPROPSHEETUI or CPSFUNC_INSERT_PSUIPAGE function code is used to create the page.

Requirements

Target platform

Desktop

Header

Compstui.h (include Compstui.h)

 

 

Send comments about this topic to Microsoft