DeleteMonitor function

Article
01/07/2021

The DeleteMonitor function removes a port monitor added by the AddMonitor function.

Syntax

BOOL DeleteMonitor(
  _In_ LPTSTR pName,
  _In_ LPTSTR pEnvironment,
  _In_ LPTSTR pMonitorName
);

Parameters

pName [in]: A pointer to a null-terminated string that specifies the name of the server from which the monitor is to be removed. If this parameter is NULL, the port monitor is removed locally.
pEnvironment [in]: A pointer to a null-terminated string that specifies the environment from which the monitor is to be removed (for example, Windows x86, Windows IA64, or Windows x64). If this parameter is NULL, the monitor is removed from the current environment of the calling application and client machine (not of the destination application and print server).
pMonitorName [in]: A pointer to a null-terminated string that specifies the name of the monitor to be removed.

Return value

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

If the function fails, the return value is zero.

Remarks

Note

This is a blocking or synchronous function and might not return immediately. How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

The caller must have SeLoadDriverPrivilege.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Winspool.h (include Windows.h)
Library	Winspool.lib
DLL	Winspool.drv
Unicode and ANSI names	DeleteMonitorW (Unicode) and DeleteMonitorA (ANSI)