Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DeletePrinterDataEx function

The DeletePrinterDataEx function deletes a specified value from the configuration data for a printer. A printer's configuration data consists of a set of named and typed values stored in a hierarchy of registry keys. The function deletes a specified value under a specified key.

Like the DeletePrinterData function, DeletePrinterDataEx can delete values stored by the SetPrinterData function. In addition, DeletePrinterDataEx can delete values stored under a specified key by the SetPrinterDataEx function.

Syntax


DWORD DeletePrinterDataEx(
  _In_  HANDLE hPrinter,
  _In_  LPCTSTR pKeyName,
  _In_  LPCTSTR pValueName
);

Parameters

hPrinter [in]

A handle to the printer for which the function deletes a value. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.

pKeyName [in]

A pointer to a null-terminated string that specifies the key containing the value to delete. Use the backslash ( \ ) character as a delimiter to specify a path that has one or more subkeys.

If pKeyName is NULL or an empty string, DeletePrinterDataEx returns ERROR_INVALID_PARAMETER.

pValueName [in]

A pointer to a null-terminated string that specifies the name of the value to delete.

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is a system error code.

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.

Requirements

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

DeletePrinterDataExW (Unicode) and DeletePrinterDataExA (ANSI)

See also

Printing
Print Spooler API Functions
DeletePrinterKey
EnumPrinterDataEx
EnumPrinterKey
GetPrinterDataEx
OpenPrinter
SetPrinterDataEx

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.