RouterFreePrinterNotifyInfo function (winsplp.h)

The print spooler's RouterFreePrinterNotifyInfo function deallocates a specified PRINTER_NOTIFY_INFO structure and its associated PRINTER_NOTIFY_INFO_DATA structure array. (These structures are described in the Microsoft Windows SDK documentation.)

Syntax

BOOL RouterFreePrinterNotifyInfo(
  [in, optional] PPRINTER_NOTIFY_INFO pInfo
);

Parameters

[in, optional] pInfo

Caller-supplied pointer to a PRINTER_NOTIFY_INFO structure (described in the Windows SDK documentation).

Return value

If the operation succeeds, the function returns TRUE. Otherwise the function returns FALSE.

Remarks

A print provider's RefreshPrinterChangeNotification function should call RouterFreePrinterNotifyInfo to deallocate structures previously allocated by RouterAllocPrinterNotifyInfo, but only if RefreshPrinterChangeNotification encounters an error. If RefreshPrinterChangeNotification succeeds, you should assume that the client application will deallocate the structures.

Besides deallocating the specified PRINTER_NOTIFY_INFO structure and its associated PRINTER_NOTIFY_INFO_DATA structure array, the function also deallocates buffer space pointed to by pBuf in any element of the PRINTER_NOTIFY_INFO_DATA structure array.

For additional information, see Supporting Printer Change Notifications.

Requirements

Requirement	Value
Target Platform	Desktop
Header	winsplp.h (include Winsplp.h)
Library	Spoolss.lib
DLL	Spoolss.dll

See also

RefreshPrinterChangeNotification

RouterAllocPrinterNotifyInfo