3.1.4.11.5 APMON

  • Article

This section describes the implementation of the XcvData method in APMON. The APMON monitor module is used to control Web Services for Devices (WSD) printers and Internet Printing Protocol (IPP) printers.<383>

For network port naming, see section 2.2.2.4.10.

For structures used with the APMON monitor module, see section 2.2.2.16. APMON also supports all of the XcvData commands listed in this section for ports connected to WSD printers (see section 3.1.4.11.4).

The following table defines command values used by the APMON monitor module.

Value

Description

"MonitorUI"

This action returns the name of the client-side monitor interface module. The pOutputData parameter is a pointer to a buffer that receives the string representing the name of the interface module.

“AssocIppDirected”

This action searches for an IPP print service at the supplied URI of the endpoint and installs the printer if found. The required value for the pInputData parameter is a pointer to a string specifying the URI of the IPP print endpoint. If an IPP print service is found, a PnPX installation of the printer is initiated; otherwise, ERROR_PRINTER_NOT_FOUND is returned [MS-ERREF].

“CheckAPPortSupport”

This action determines whether the queried server supports the APMON-based XcvData commands. The required value for the pOutputData parameter is a pointer to a variable that receives a nonzero DWORD value: 0x00000000 if the queried server supports APMON commands; otherwise, ERROR_INVALID_PARAMETER is returned [MS-ERREF].

"GetAPPortInfo"

This action gets configuration information for a printer port. The pOutputData parameter points to a buffer that receives an APPORT_DATA_1 structure (section 2.2.2.16.1) describing the port.

"ConfigAPPort"

This action configures a printer port. The pInputData parameter is a pointer to an APPORT_DATA_1 structure (section 2.2.2.16.1).

“GetBackupAPPortSize”

This action initiates a query for the size of the APMON port backup data for a printer port. The required value for the pOutputData parameter is a pointer to a variable that receives a nonzero DWORD value that indicates the size of an APMON_BACKUP_PORT_DATA structure (section 2.2.2.16.2) that should be allocated for a subsequent BackupAPPort command for this queried port.

“BackupAPPort”

This action initiates a query for the APMON port backup data. The required value for the pOutputData parameter is a pointer to a buffer that receives an APMON_BACKUP_PORT_DATA structure (section 2.2.2.16.2).

“RestoreAPPort”

This action searches for a WSD or IPP print device based on the input data. The required value for the pInputData parameter is an APMON_BACKUP_PORT_DATA structure (section 2.2.2.16.2) that contains the values relevant to the printer port to restore. If a matching WSD or IPP printer service is found, a PnPX installation of the printer is initiated. The required value for the pOutputData parameter is a pointer to a buffer that receives a string identifying the new port by name.