3.1.4.11.3 TCPMON

  • Article

Information about the implementation of the TCPMON monitor module can be found in the command value following table and in the subsections that follow.

The TCPMON monitor module is used to control printers directly connected to a TCP/IP network.<389>

For network port naming, see section 2.2.4.10.

For structures used with the TCPMON monitor module, see section 2.2.2.14

The following table defines command values used by the TCPMON monitor module.<390>

Value

Description

"AddPort"

This action adds a printer port. The pInputData parameter is a pointer to a PORT_DATA_1 or PORT_DATA_2 structure.

"DeletePort"

This action deletes a printer port. The pInputData parameter is a pointer to a DELETE_PORT_DATA_1 structure.

"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.

"ConfigPort"

This action configures a printer port. The pInputData parameter is a pointer to a PORT_DATA_1 or PORT_DATA_2 structure.

"GetConfigInfo"

This action gets configuration information for a printer port. The pInputData parameter is a pointer to a CONFIG_INFO_DATA_1 structure. The pOutputData parameter points to a buffer that receives a PORT_DATA_1 or PORT_DATA_2 structure describing the port.

"HostAddress"

This action gets the printer's host name. pOutputData is a pointer to a buffer that receives a string containing the printer's host name.

"IPAddress"

This action gets the printer's IP address. pOutputData is a pointer to a buffer that receives a string containing the printer's IP address.

"SNMPCommunity"

This action gets the printer's Simple Network Management Protocol (SNMP) [RFC1157] community name. pOutputData is a pointer to a buffer that receives a string containing the printer's SNMP community name.

"SNMPDeviceIndex"

This action gets the printer's SNMP device index. pOutputData is a pointer to a variable that receives a DWORD value containing the printer's SNMP device index.

"SNMPEnabled"

This action determines whether SNMP is enabled for the printer. pOutputData is a pointer to a variable that receives the DWORD value 0x00000000 if SNMP is disabled and a nonzero value otherwise.

"GetIdlePollingState"

This action determines whether TCPMON is set to poll automatically for the printer ("idle polling"). pOutputData is a pointer to a variable that receives the DWORD value 0x00000000 if idle polling is disabled, and a nonzero value otherwise.

"SetIdlePollingState"

This action sets the idle polling state for the printer. pInputData is a pointer to a DWORD which is set to 0x00000001 to enable idle polling, and to 0x00000000 to disable it.

"SetDeviceIDOid"

This action sets the OID (Object Identifier for a device on the network) used to query the IEEE 1284 device ID from the printer. (For details, see [IEEE1284].) pInputData is a pointer to a string specifying the OID. If this OID is not set, TCPMON uses a default of "1.3.6.1.4.1.2699.1.2.1.2.1.1.3.<1-based port index>".

"DeviceID"

This action initiates a query for the IEEE 1284 device ID.  pOutputData is a pointer to a buffer that receives a string containing the IEEE 1284 device ID. (For details, see [IEEE1284]).

"GetPortList"

This action requests the list of supported ports on a device. pInputData is a pointer to a string containing the IP address of hostname of the device. pOutputData is a pointer to a buffer that receives a PORT_DATA_LIST_1 structure.

"CleanupPort"

This action attempts to remove the TCP/IP port associated with the hXcv handle. If printers are still using the port, it is not removed.