大网数据广告活动
打印与设备

AddPort function (Winspool.h)

· 52CE 我爱测

The AddPort function adds the name of a port to the list of supported ports. The AddPort function is exported by the port monitor.

The AddPort function adds the name of a port to the list of supported ports. The AddPort function is exported by the port monitor.

Syntax

BOOL AddPort(
  _In_ LPTSTR pName,
  _In_ HWND   hWnd,
  _In_ LPTSTR pMonitorName
);

Parameters

pName [in]

A pointer to a zero-terminated string that specifies the name of the server to which the port is connected. If this parameter is NULL, the port is local.

hWnd [in]

A handle to the parent window of the AddPort dialog box.

pMonitorName [in]

A pointer to a zero-terminated string that specifies the monitor associated with the port.

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 AddPort function browses the network to find existing ports, and displays a dialog box for the user. The AddPort function should validate the port name entered by the user by calling EnumPorts to ensure that no duplicate names exist.

The caller of the AddPort function must have SERVER_ACCESS_ADMINISTER access to the server to which the port is connected.

To add a port without displaying a dialog box, call the XcvData function instead of AddPort. For more information about XcvData, see the Microsoft Windows Driver Development Kit (DDK).

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 Spoolss.dll
Unicode and ANSI names AddPortW (Unicode) and AddPortA (ANSI)

See also

Printing

Print Spooler API Functions

DeletePort

EnumPorts

SetPort

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 05/31/2018
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。