DeletePrinterKey 函数

DeletePrinterKey 函数删除指定打印机的指定键及其所有子项。

语法

DWORD DeletePrinterKey(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName
);

hPrinter [in]

函数删除其密钥的打印机的句柄。使用 OpenPrinter 或 AddPrinter 函数检索打印机句柄。

pKeyName [in]

指向以 null 结尾的字符串的指针，该字符串指定要删除的键。使用反斜杠 ( \ ) 字符作为分隔符来指定包含一个或多个子项的路径。

如果 pKeyName 是空字符串 (“”) ， 则 DeletePrinterKey 将删除打印机顶级键下的所有键。如果 pKeyName 为 NULL， 则 DeletePrinterKey 返回ERROR_INVALID_PARAMETER。

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

如果函数失败，则返回值为系统错误代码。

注意

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

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