SplPromptUIInUsersSession function

The SplPromptUIInUsersSession function displays a standard message box in the session indicated by the printer handle and job ID.

Syntax


BOOL SplPromptUIInUsersSession(
  _In_  HANDLE        hPrinter,
  _In_  DWORD         JobId,
  _In_  PSHOWUIPARAMS pUIParams,
  _Out_ DWORD         *pResponse
);

Parameters

hPrinter [in]

Handle to the printer.

JobId [in]

Specifies the print job.

pUIParams [in]

Pointer to a SHOWUIPARAMS structure that contains values that determine the appearance and behavior of the message box.

pResponse [out]

Pointer to a memory location that contains either the user's response or the IDASYNC constant. For more information, see the Remarks section.

Return value

On success, the SplPromptUIInUsersSession function returns TRUE; otherwise it returns FALSE.

Remarks

If pUIParams ->bWait is FALSE, this function returns immediately without waiting for the user's response. In that case, *pResponse is set to IDASYNC.

If you plan to use this function in a driver intended to run under Windows 2000, you must load spoolss.dll by a call to the LoadLibrary function, and then find the address of this function within that DLL by a call to the GetProcAddress function. (LoadLibrary and GetProcAddress are described in the Microsoft Windows SDK documentation.) If the call to GetProcAddress fails, you must use an alternative mechanism to display user interface elements.

Requirements

Target platform

Desktop

Version

The SplPromptUIInUsersSession function is available in Windows XP and later

Header

Winsplp.h (include Winsplp.h)

Library

Spoolss.lib

DLL

Spoolss.dll

See also

SHOWUIPARAMS
SplIsSessionZero

 

 

Send comments about this topic to Microsoft

Show: