SetPort 函数

SetPort 函数设置与打印机端口关联的状态。

语法

BOOL SetPort(
  _In_ LPTSTR pName,
  _In_ LPTSTR pPortName,
  _In_ DWORD  dwLevel,
  _In_ LPBYTE pPortInfo
);

pName [in]

指向以零结尾的字符串的指针，该字符串指定端口连接到的打印机服务器的名称。如果端口位于本地计算机上，请将此参数设置为 NULL 。

pPortName [in]

指向以零结尾的字符串的指针，该字符串指定打印机端口的名称。

dwLevel [in]

指定 pPortInfo 参数指向的结构类型。

此值必须为 3，对应于 PORT_INFO_3 数据结构。

pPortInfo [in]

指向包含要设置的端口状态信息的 PORT_INFO_3 结构的指针。

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

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

注意

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

SetPort 函数的调用方必须以管理员身份执行。此外，如果调用方是端口监视器或语言监视器，则必须调用 RevertToSelf 以在调用 SetPort 之前停止模拟。

调用 SetPort 的所有程序必须具有对端口所连接到的服务器SERVER_ACCESS_ADMINISTER访问权限。

将打印机端口状态值设置为严重性值PORT_STATUS_TYPE_ERROR时，打印后台处理程序将停止向端口发送作业。当另一次调用 SetPort 清除端口状态时，打印后台处理程序继续将作业发送到端口。

要求	值
最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
标头	Winspool.h (包括 Windows.h)
库	Winspool.lib
DLL	Winspool.drv
Unicode 和 ANSI 名称	SetPortW (Unicode) 和 SetPortA (ANSI)