Comandos TCPMON Xcv
Esta seção descreve os comandos que podem ser especificados em uma chamada para a função XcvData ou XcvDataPort , quando ela está se comunicando com o TCPMON (monitor de porta TCP/IP padrão). Cada comando é especificado pela cadeia de caracteres pszDataName na chamada para essas funções. Determinados comandos exigem um buffer de entrada ou um buffer de saída ou ambos. Os parâmetros pInputData e pOutputData dessas funções mantêm os endereços desses buffers.
A tabela que aparece na descrição de cada um dos comandos a seguir lista os parâmetros XcvData e XcvDataPort usados com os comandos . Observe que o parâmetro hXcv (comum a ambas as funções) não está listado, nem o parâmetro pdwStatus da função XcvData.
Comando AddPort
O comando AddPort adiciona uma porta TCP/IP padrão, que pode ser uma porta LPR ou uma porta TCP/IP RAW.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"AddPort" |
| pInputData | Endereço de uma estrutura de PORT_DATA_1 |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeeded | Endereço de um DWORD |
XcvData retornará NO_ERROR se puder adicionar a porta. Além dos códigos de erro normais, XcvData retornará ERROR_ACCESS_DENIED se o usuário não tiver privilégios suficientes para criar uma porta no servidor. Esse comando requer privilégios de SERVER_ACCESS_ADMINISTER. Se o parâmetro pInputData for NULL, a função retornará ERROR_INVALID_DATA. Se pInputData-->dwVersion não for igual a 1, a função retornará ERROR_INVALID_LEVEL.
Comando ConfigPort
O comando ConfigPort configura uma porta de monitor de porta TCP/IP padrão existente.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"ConfigPort" |
| pInputData | Endereço de uma estrutura de PORT_DATA_1 |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeeded | Endereço de um DWORD |
XcvData retornará NO_ERROR se puder configurar a porta. Além dos códigos de erro normais, XcvData retornará ERROR_ACCESS_DENIED se o chamador não tiver privilégios suficientes para executar a solicitação. Esse comando requer privilégios de SERVER_ACCESS_ADMINISTER. Se o parâmetro pInputData for NULL ou o valor em cbInputData for menor do que o necessário, a função retornará ERROR_INVALID_DATA. Se pInputData-->dwVersion não for igual a 1, a função retornará ERROR_INVALID_LEVEL.
Comando DeletePort
O comando DeletePort exclui uma porta do monitor de porta TCP/IP padrão.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"DeletePort" |
| pInputData | Endereço da estrutura de DELETE_PORT_DATA_1 |
| cbInputData | sizeof(DELETE_PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeeded | Endereço de um DWORD |
XcvData retornará NO_ERROR se a porta for excluída com êxito. Além dos códigos de erro normais, XcvData retornará ERROR_ACCESS_DENIED se o chamador não tiver privilégios suficientes no servidor. Esse comando requer privilégios de SERVER_ACCESS_ADMINISTER. Se o parâmetro pInputData for NULL ou se o parâmetro cbInputData for menor que o necessário, a função retornará ERROR_INVALID_DATA. Se pInputData-->dwVersion não for igual a 1, a função retornará ERROR_INVALID_LEVEL.
Comando GetConfigInfo
O comando GetConfigInfo obtém as informações de configuração de uma porta específica. Nesse caso, o identificador de dados Xcv deve apontar para uma porta de monitor de porta TCP/IP padrão específica para que a porta possa ser identificada.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"GetConfigInfo" |
| pInputData | Endereço de uma estrutura de CONFIG_INFO_DATA_1 |
| cbInputData | sizeof(CONFIG_INFO_DATA_1) |
| pOutputData | Endereço de uma estrutura de PORT_DATA_1 |
| cbOutputData | sizeof(PORT_DATA_1) |
| pcbOutputNeeded | Endereço de um DWORD que contém o número de bytes necessários para o buffer apontado por pOutputData |
XcvData retornará NO_ERROR se puder obter as informações de configuração da porta. Se pInputData for NULL ou se cbInputData for menor que o necessário, a função retornará ERROR_INVALID_DATA. Se pInputData-->dwVersion não for igual a 1, a função retornará ERROR_INVALID_LEVEL. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL.
Comando HostAddress
O comando HostAddress obtém o nome do host da impressora.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"HostAddress" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Endereço de um buffer que recebe uma cadeia de caracteres que contém o nome do host da impressora |
| cbOutputData | Tamanho do buffer apontado por pOutputData |
| pcbOutputNeeded | Endereço de um DWORD que contém o número de bytes necessários para o buffer apontado por pOutputData |
XcvData retornará NO_ERROR se puder obter o nome do host da impressora. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL. Se pOutputData for NULL, a função retornará ERROR_INVALID_PARAMETER.
Comando IPAddress
O comando IPAddress obtém o endereço IP da impressora.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"IPAddress" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Endereço de um buffer que recebe uma cadeia de caracteres que contém o endereço IP da impressora |
| cbOutputData | Tamanho do buffer apontado por pOutputData |
| pcbOutputNeeded | Endereço de um DWORD que contém o número de bytes necessários para o buffer apontado por pOutputData |
XcvData retornará NO_ERROR se puder obter o endereço IP da impressora. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL. Se pOutputData for NULL, a função retornará ERROR_INVALID_PARAMETER.
Comando MonitorUI
O comando MonitorUI obtém o nome da DLL da interface do usuário do monitor de porta que fornece uma interface para TCPMON.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"MonitorUI" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Endereço de um buffer que recebe o nome da DLL da interface do usuário do monitor de porta |
| cbOutputData | Número de bytes na cadeia de caracteres que contém o nome da DLL da interface do usuário do monitor de porta |
| pcbOutputNeeded | Endereço de um DWORD que contém o número de bytes necessários para o buffer apontado por pOutputData |
XcvData retornará NO_ERROR se for capaz de obter o nome da DLL da interface do usuário. Além dos códigos de erro normais, XcvData retornará ERROR_ACCESS_DENIED se o chamador não tiver privilégios suficientes no servidor. Esse comando requer privilégios de SERVER_ACCESS_ADMINISTER. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL. Se pOutputData for NULL, a função retornará ERROR_INVALID_PARAMETER.
SNMPCommunity
O comando SNMPCommunity obtém o nome da comunidade SNMP (Simple Network Management Protocol) para uma impressora.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"SNMPCommunity" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Endereço de um buffer que recebe uma cadeia de caracteres que contém a comunidade SNMP da impressora |
| cbOutputData | Tamanho do buffer necessário para conter a cadeia de caracteres apontada pelo parâmetro pOutputData |
| pcbOutputNeeded | Endereço de um DWORD que contém o número de bytes necessários para o buffer apontado por pOutputData |
XcvData retornará NO_ERROR se puder obter o nome da comunidade SNMP da impressora. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL. Se pOutputData for NULL, a função retornará ERROR_INVALID_PARAMETER.
SNMPDeviceIndex
O comando SNMPDeviceIndex obtém o índice de dispositivo SNMP (Simple Network Management Protocol) da impressora.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"SNMPDeviceIndex" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Endereço de um buffer que recebe o índice do dispositivo |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeeded | Endereço de um DWORD que contém sizeof(DWORD) |
XcvData retornará NO_ERROR se puder obter o índice de dispositivo SNMP da impressora. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL. Se pOutputData for NULL, a função retornará ERROR_INVALID_PARAMETER.
SNMPEnabled
O comando SNMPEnabled determina se o SNMP (Simple Network Management Protocol) está habilitado para o dispositivo atual.
| Parâmetro XcvData | Valor |
|---|---|
| pszDataName | L"SNMPEnabled" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Endereço de um buffer que recebe um valor DWORD |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeeded | Endereço de um DWORD que contém sizeof(DWORD) |
XcvData retornará NO_ERROR se o SNMP estiver habilitado para o dispositivo. Se cbOutputData for menor que o necessário, a função retornará ERROR_INVALID_PARAMETER quando pcbOutputNeeded for NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded não for NULL. Se pOutputData for NULL, a função retornará ERROR_INVALID_PARAMETER.