GetPrintProcessorDirectory function

The GetPrintProcessorDirectory function retrieves the path to the print processor directory on the specified server.

Syntax

BOOL GetPrintProcessorDirectory(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pEnvironment,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pPrintProcessorInfo,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

Parameters

pName [in]

A pointer to a null-terminated string that specifies the name of the server. If this parameter is NULL, a local path is returned.

pEnvironment [in]

A pointer to a null-terminated string that specifies the environment (for example, Windows x86, Windows IA64, or Windows x64). If this parameter is NULL, the current environment of the calling application and client machine (not of the destination application and print server) is used.

Level [in]

The structure level. This value must be 1.

pPrintProcessorInfo [out]

A pointer to a buffer that receives the path. Note that, for operating systems prior to Windows Server 2003 SP 1, the path is in the local format for the server, not the true remote format. For example, the path is given as "%Windir%\System32\Spool\Prtprocs\%Environment%" instead of "\\ServerName\Print$\Prtprocs\%Environment%", even when called for a remote server. For the operating systems Windows Server 2003 SP 1 and later, the true remote path is returned.

cbBuf [in]

The size of the buffer pointed to by pPrintProcessorInfo.

pcbNeeded [out]

A pointer to a value that specifies the number of bytes copied if the function succeeds, or the number of bytes required if cbBuf is too small.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero.

Remarks

Requirements

See also

Printing

Print Spooler API Functions

AddPrintProcessor