DeletePort 函数

DeletePort 函数显示允许用户删除端口名称的对话框。

语法

BOOL DeletePort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pPortName
);

parameters

pName [in]

指向以零结尾的字符串的指针,该字符串指定应删除其端口的服务器的名称。 如果此参数为 NULL,则删除本地端口。

hWnd [in]

端口删除对话框的父窗口的句柄。

pPortName [in]

指向以零结尾的字符串的指针,该字符串指定应删除的端口的名称。

返回值

如果函数成功,则返回值为非零值。

如果函数失败,则返回值为零。

注解

注意

这是一个阻塞或同步函数,可能不会立即返回。 此函数的返回速度取决于运行时因素,例如网络状态、打印服务器配置以及编写应用程序时难以预测的打印机驱动程序实现因素。 从管理与用户界面交互的线程调用此函数可能会使应用程序看起来无响应。

应用程序可以通过调用 EnumPorts 函数来检索有效端口的名称。

如果打印机当前已连接到指定的端口, DeletePort 函数将返回错误。

DeletePort 函数的调用方必须具有对端口所连接到的服务器SERVER_ACCESS_ADMINISTER访问权限。

要求

要求
最低受支持的客户端
Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器
Windows 2000 Server [仅限桌面应用]
标头
Winspool.h (包括 Windows.h)

Winspool.lib
DLL
Winspool.drv
Unicode 和 ANSI 名称
DeletePortW (Unicode) 和 DeletePortA (ANSI)

另请参阅

打印

打印后台处理程序 API 函数

AddPort

EnumPorts