Comandos Xcv de TCPMON
En esta sección se describen los comandos que se pueden especificar en una llamada a la función XcvData o XcvDataPort , cuando se comunica con el monitor de puerto TCP/IP estándar (TCPMON). Cada comando se especifica mediante la cadena pszDataName en la llamada a estas funciones. Algunos comandos requieren un búfer de entrada o un búfer de salida, o ambos. Los parámetros pInputData y pOutputData de estas funciones contienen las direcciones de estos búferes.
La tabla que aparece en la descripción de cada uno de los comandos siguientes enumera los parámetros XcvData y XcvDataPort que se usan con los comandos . Tenga en cuenta que el parámetro hXcv (común a ambas funciones) no aparece en la lista, ni es el parámetro pdwStatus de la función XcvData.
Comando AddPort
El comando AddPort agrega un puerto TCP/IP estándar, que puede ser un puerto LPR o un puerto TCP/IP sin formato.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"AddPort" |
| pInputData | Dirección de una estructura de PORT_DATA_1 |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeededed | Dirección de un DWORD |
XcvData devuelve NO_ERROR si puede agregar el puerto. Además de los códigos de error normales, XcvData devuelve ERROR_ACCESS_DENIED si el usuario no tiene privilegios suficientes para crear un puerto en el servidor. Este comando requiere SERVER_ACCESS_ADMINISTER privilegios. Si el parámetro pInputData es NULL, la función devuelve ERROR_INVALID_DATA. Si pInputData-->dwVersion no es igual a 1, la función devuelve ERROR_INVALID_LEVEL.
Comando ConfigPort
El comando ConfigPort configura un puerto de supervisión de puerto TCP/IP estándar existente.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"ConfigPort" |
| pInputData | Dirección de una estructura de PORT_DATA_1 |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeededed | Dirección de un DWORD |
XcvData devuelve NO_ERROR si puede configurar el puerto. Además de los códigos de error normales, XcvData devuelve ERROR_ACCESS_DENIED si el autor de la llamada no tiene privilegios suficientes para realizar la solicitud. Este comando requiere SERVER_ACCESS_ADMINISTER privilegios. Si el parámetro pInputData es NULL o el valor de cbInputData es menor de lo necesario, la función devuelve ERROR_INVALID_DATA. Si pInputData-->dwVersion no es igual a 1, la función devuelve ERROR_INVALID_LEVEL.
Comando DeletePort
El comando DeletePort elimina un puerto del monitor de puerto TCP/IP estándar.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"DeletePort" |
| pInputData | Dirección de la estructura de DELETE_PORT_DATA_1 |
| cbInputData | sizeof(DELETE_PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeededed | Dirección de un DWORD |
XcvData devuelve NO_ERROR si el puerto se elimina correctamente. Además de los códigos de error normales, XcvData devuelve ERROR_ACCESS_DENIED si el autor de la llamada no tiene privilegios suficientes en el servidor. Este comando requiere SERVER_ACCESS_ADMINISTER privilegios. Si el parámetro pInputData es NULL o si el parámetro cbInputData es menor de lo necesario, la función devuelve ERROR_INVALID_DATA. Si pInputData-->dwVersion no es igual a 1, la función devuelve ERROR_INVALID_LEVEL.
Comando GetConfigInfo
El comando GetConfigInfo obtiene la información de configuración de un puerto determinado. En este caso, el identificador de datos Xcv debe apuntar a un puerto de supervisión de puerto TCP/IP estándar determinado para que se pueda identificar el puerto.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"GetConfigInfo" |
| pInputData | Dirección de una estructura de CONFIG_INFO_DATA_1 |
| cbInputData | sizeof(CONFIG_INFO_DATA_1) |
| pOutputData | Dirección de una estructura de PORT_DATA_1 |
| cbOutputData | sizeof(PORT_DATA_1) |
| pcbOutputNeeded | Dirección de un DWORD que contiene el número de bytes necesarios para el búfer al que apunta pOutputData |
XcvData devuelve NO_ERROR si puede obtener la información de configuración del puerto. Si pInputData es NULL o si cbInputData es menor de lo necesario, la función devuelve ERROR_INVALID_DATA. Si pInputData-->dwVersion no es igual a 1, la función devuelve ERROR_INVALID_LEVEL. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL.
Comando HostAddress
El comando HostAddress obtiene el nombre de host de la impresora.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"HostAddress" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Dirección de un búfer que recibe una cadena que contiene el nombre de host de la impresora |
| cbOutputData | Tamaño del búfer al que apunta pOutputData |
| pcbOutputNeeded | Dirección de un DWORD que contiene el número de bytes necesarios para el búfer al que apunta pOutputData |
XcvData devuelve NO_ERROR si puede obtener el nombre del host de la impresora. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL. Si pOutputData es NULL, la función devuelve ERROR_INVALID_PARAMETER.
Comando IPAddress
El comando IPAddress obtiene la dirección IP de la impresora.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"IPAddress" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Dirección de un búfer que recibe una cadena que contiene la dirección IP de la impresora |
| cbOutputData | Tamaño del búfer al que apunta pOutputData |
| pcbOutputNeeded | Dirección de un DWORD que contiene el número de bytes necesarios para el búfer al que apunta pOutputData |
XcvData devuelve NO_ERROR si puede obtener la dirección IP de la impresora. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL. Si pOutputData es NULL, la función devuelve ERROR_INVALID_PARAMETER.
Comando MonitorUI
El comando MonitorUI obtiene el nombre del archivo DLL de interfaz de usuario del monitor de puerto que proporciona una interfaz a TCPMON.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"MonitorUI" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Dirección de un búfer que recibe el nombre del archivo DLL de la interfaz de usuario del monitor de puerto |
| cbOutputData | Número de bytes de la cadena que contiene el nombre del archivo DLL de la interfaz de usuario del monitor de puerto |
| pcbOutputNeeded | Dirección de un DWORD que contiene el número de bytes necesarios para el búfer al que apunta pOutputData |
XcvData devuelve NO_ERROR si puede obtener el nombre del archivo DLL de la interfaz de usuario. Además de los códigos de error normales, XcvData devuelve ERROR_ACCESS_DENIED si el autor de la llamada no tiene privilegios suficientes en el servidor. Este comando requiere SERVER_ACCESS_ADMINISTER privilegio. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL. Si pOutputData es NULL, la función devuelve ERROR_INVALID_PARAMETER.
SNMPCommunity
El comando SNMPCommunity obtiene el nombre de comunidad del Protocolo de administración de red simple (SNMP) para una impresora.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"SNMPCommunity" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Dirección de un búfer que recibe una cadena que contiene la comunidad SNMP de la impresora |
| cbOutputData | Tamaño del búfer necesario para contener la cadena a la que apunta el parámetro pOutputData |
| pcbOutputNeeded | Dirección de un DWORD que contiene el número de bytes necesarios para el búfer al que apunta pOutputData |
XcvData devuelve NO_ERROR si puede obtener el nombre de la comunidad SNMP de la impresora. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL. Si pOutputData es NULL, la función devuelve ERROR_INVALID_PARAMETER.
SNMPDeviceIndex
El comando SNMPDeviceIndex obtiene el índice de dispositivo Simple Network Management Protocol (SNMP) de la impresora.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"SNMPDeviceIndex" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Dirección de un búfer que recibe el índice del dispositivo |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeeded | Dirección de un DWORD que contiene sizeof(DWORD) |
XcvData devuelve NO_ERROR si puede obtener el índice del dispositivo SNMP de la impresora. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL. Si pOutputData es NULL, la función devuelve ERROR_INVALID_PARAMETER.
SNMPEnabled
El comando SNMPEnabled determina si el Protocolo simple de administración de redes (SNMP) está habilitado para el dispositivo actual.
| Parámetro XcvData | Valor |
|---|---|
| pszDataName | L"SNMPEnabled" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Dirección de un búfer que recibe un valor DWORD |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeededed | Dirección de un DWORD que contiene sizeof(DWORD) |
XcvData devuelve NO_ERROR si SNMP está habilitado para el dispositivo. Si cbOutputData es menor de lo necesario, la función devuelve ERROR_INVALID_PARAMETER cuando pcbOutputNeeded es NULL y ERROR_INSUFFICIENT_BUFFER cuando pcbOutputNeeded no es NULL. Si pOutputData es NULL, la función devuelve ERROR_INVALID_PARAMETER.