IMAPIViewContext::GetPrintSetup

The IMAPIViewContext::GetPrintSetup method retrieves the current print setup so as to print a message.

Quick Info

See IMAPIViewContext : IUnknownTR60NE.

HRESULT GetPrintSetup(

Parameters

ulFlags

[in] Bitmask of flags that controls the type of the returned strings. The following flag can be set:

MAPI_UNICODE

The returned strings are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.

lppFormPrintSetup

[out] Pointer to the pointer to the returned FORMPRINTSETUPGADGNR structure. The FORMPRINTSETUP structure holds information on the print setup.

Return Value

S_OK

The call succeeded and has returned the expected value or values.

Remarks

Form objects call the IMAPIViewContext::GetPrintSetup method to retrieve the current print setup to print the current message. A form should pass the MAPI_UNICODE flag in the ulFlags parameter if Unicode strings are required for the hDevMode and hDevName members of the FORMPRINTSETUP structure returned in the lppFormPrintSetup parameter. Otherwise, GetPrintSetup returns the contents of these members as ANSI strings.

The returned FORMPRINTSETUP structure must be freed by the calling form using the MAPIFreeBuffer16U06F function. The hDevMode and hDevNames members must be allocated using the Win32 function GlobalAlloc and must be freed using the Win32 function GlobalFree.

For information about implementing the interfaces related to form servers, see MAPI Form Interfaces Used by Client Applications1AR39HN.

See Also