3.1.4.2.17 RpcDeletePrinterData (Opnum 73)

  • Article

RpcDeletePrinterData deletes specified configuration data for a printer.<294>

 DWORD RpcDeletePrinterData(
   [in] PRINTER_HANDLE hPrinter,
   [in, string] wchar_t* pValueName
 );

hPrinter: A handle to a printer object that was opened by RpcAddPrinter (section 3.1.4.2.3), RpcAddPrinterEx (section 3.1.4.2.15), RpcOpenPrinter (section 3.1.4.2.2), or RpcOpenPrinterEx (section 3.1.4.2.14).

pValueName: A pointer to a string that identifies the configuration data to delete. For rules governing value names, see section 2.2.4.18.

The value name is an arbitrary string defined by the printer driver associated with the printer object. The value name "ChangeID" is reserved by the protocol and MUST NOT be used in a call to RpcDeletePrinterData.<295>

Return Values: This method MUST return zero (ERROR_SUCCESS) to indicate successful completion or a nonzero Windows error code to indicate failure [MS-ERREF].

Upon receiving this message, the server validates parameters as follows:

  • The server MUST perform the validation steps that are specified in PRINTER_HANDLE Parameters (section 3.1.4.1.11).

  • The server MAY verify that the value name is not "ChangeID" and that it complies with the rules specified in section 2.2.4.18.

  • Additional validation SHOULD<296> be performed.

If parameter validation fails, the server MUST fail the operation immediately and return a nonzero error response to the client. Otherwise, the server MUST process the message and compose a response to the client as follows:

  • Delete the printer data specified by pValueName.<297>

  • Return the status of the operation.