OPEN_PRINTER_PROPS_INFOA structure (shellapi.h)

  • Article

Identifies a particular property sheet in a printer's property pages and whether that property sheet should be modal. Optionally used with the SHInvokePrinterCommand function.

Syntax

typedef struct _OPEN_PRINTER_PROPS_INFOA {
  DWORD dwSize;
  LPSTR pszSheetName;
  UINT  uSheetIndex;
  DWORD dwFlags;
  BOOL  bModal;
} OPEN_PRINTER_PROPS_INFOA, *POPEN_PRINTER_PROPS_INFOA;

Members

dwSize

Type: DWORD

The size of the structure.

pszSheetName

Type: LPSTR

The name of the property sheet. If the specified sheet is not found, the property sheet still appears with the default first page.

uSheetIndex

Type: UINT

The index of the property sheet in the array of property sheets that makes up the window. If empty or invalid, the default first page is displayed.

dwFlags

Type: DWORD

Not used.

bModal

Type: BOOL

TRUE if the property sheet should be modal; otherwise, FALSE.

Remarks

This structure can be passed in the lpBuf2 parameter of the SHInvokePrinterCommand function when that function's uAction parameter is set to PRINTACTION_PROPERTIES.

Note

The shellapi.h header defines OPEN_PRINTER_PROPS_INFO as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header shellapi.h