Comandi TCPMON Xcv
Questa sezione descrive i comandi che possono essere specificati in una chiamata alla funzione XcvData o XcvDataPort, quando comunica con il monitor della porta TCP/IP standard (TCPMON). Ogni comando viene specificato dalla stringa pszDataName nella chiamata a queste funzioni. Alcuni comandi richiedono un buffer di input o un buffer di output o entrambi. I parametri pInputData e pOutputData di queste funzioni contengono gli indirizzi di questi buffer.
La tabella visualizzata nella descrizione di ognuno dei comandi seguenti elenca i parametri XcvData e XcvDataPort usati con i comandi. Si noti che il parametro hXcv (comune a entrambe le funzioni) non è elencato, né è il parametro pdwStatus della funzione XcvData.
Comando AddPort
Il comando AddPort aggiunge una porta TCP/IP standard, che può essere una porta LPR o una porta TCP/IP RAW.
Parametro XcvData | Valore |
---|---|
pszDataName | L"AddPort" |
pInputData | Indirizzo di una struttura PORT_DATA_1 |
cbInputData | sizeof(PORT_DATA_1) |
pOutputData | NULL |
cbOutputData | 0 |
pcbOutputNeeded | Indirizzo di una DWORD |
XcvData restituisce NO_ERROR se può aggiungere la porta. Oltre ai normali codici di errore, XcvData restituisce ERROR_ACCESS_DENIED se l'utente ha privilegi insufficienti per creare una porta nel server. Questo comando richiede SERVER_ACCESS_ADMINISTER privilegio. Se il parametro pInputData è NULL, la funzione restituisce ERROR_INVALID_DATA. Se pInputData-->dwVersion non è uguale a 1, la funzione restituisce ERROR_INVALID_LEVEL.
Comando ConfigPort
Il comando ConfigPort configura una porta di monitoraggio porta TCP/IP standard esistente.
Parametro XcvData | Valore |
---|---|
pszDataName | L"ConfigPort" |
pInputData | Indirizzo di una struttura PORT_DATA_1 |
cbInputData | sizeof(PORT_DATA_1) |
pOutputData | NULL |
cbOutputData | 0 |
pcbOutputNeeded | Indirizzo di una DWORD |
XcvData restituisce NO_ERROR se può configurare la porta. Oltre ai normali codici di errore, XcvData restituisce ERROR_ACCESS_DENIED se il chiamante ha privilegi insufficienti per eseguire la richiesta. Questo comando richiede SERVER_ACCESS_ADMINISTER privilegio. Se il parametro pInputData è NULL o il valore in cbInputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_DATA. Se pInputData-->dwVersion non è uguale a 1, la funzione restituisce ERROR_INVALID_LEVEL.
Comando DeletePort
Il comando DeletePort elimina una porta dal monitor della porta TCP/IP standard.
Parametro XcvData | Valore |
---|---|
pszDataName | L"DeletePort" |
pInputData | Indirizzo della struttura DELETE_PORT_DATA_1 |
cbInputData | sizeof(DELETE_PORT_DATA_1) |
pOutputData | NULL |
cbOutputData | 0 |
pcbOutputNeeded | Indirizzo di una DWORD |
XcvData restituisce NO_ERROR se la porta viene eliminata correttamente. Oltre ai normali codici di errore, XcvData restituisce ERROR_ACCESS_DENIED se il chiamante ha privilegi insufficienti nel server. Questo comando richiede SERVER_ACCESS_ADMINISTER privilegio. Se il parametro pInputData è NULL o se il parametro cbInputData è minore di quello richiesto, la funzione restituisce ERROR_INVALID_DATA. Se pInputData-->dwVersion non è uguale a 1, la funzione restituisce ERROR_INVALID_LEVEL.
Comando GetConfigInfo
Il comando GetConfigInfo ottiene le informazioni di configurazione di una determinata porta. In questo caso, l'handle dati Xcv deve puntare a una determinata porta di monitoraggio porta TCP/IP standard in modo che la porta possa essere identificata.
Parametro XcvData | Valore |
---|---|
pszDataName | L"GetConfigInfo" |
pInputData | Indirizzo di una struttura CONFIG_INFO_DATA_1 |
cbInputData | sizeof(CONFIG_INFO_DATA_1) |
pOutputData | Indirizzo di una struttura PORT_DATA_1 |
cbOutputData | sizeof(PORT_DATA_1) |
pcbOutputNeeded | Indirizzo di un DWORD contenente il numero di byte necessari per il buffer a cui punta pOutputData |
XcvData restituisce NO_ERROR se può ottenere le informazioni di configurazione per la porta. Se pInputData è NULL o se cbInputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_DATA. Se pInputData--dwVersion> non è uguale a 1, la funzione restituisce ERROR_INVALID_LEVEL. Se cbOutputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeeded è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded è diverso da NULL.
Comando HostAddress
Il comando HostAddress ottiene il nome host della stampante.
Parametro XcvData | Valore |
---|---|
pszDataName | L"HostAddress" |
pInputData | NULL |
cbInputData | 0 |
pOutputData | Indirizzo di un buffer che riceve una stringa contenente il nome host della stampante |
cbOutputData | Dimensioni del buffer a cui punta pOutputData |
pcbOutputNeeded | Indirizzo di un DWORD contenente il numero di byte necessari per il buffer a cui punta pOutputData |
XcvData restituisce NO_ERROR se può ottenere il nome dell'host della stampante. Se cbOutputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeeded è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded è diverso da NULL. Se pOutputData è NULL, la funzione restituisce ERROR_INVALID_PARAMETER.
Comando IPAddress
Il comando IPAddress ottiene l'indirizzo IP della stampante.
Parametro XcvData | Valore |
---|---|
pszDataName | L"IPAddress" |
pInputData | NULL |
cbInputData | 0 |
pOutputData | Indirizzo di un buffer che riceve una stringa contenente l'indirizzo IP della stampante |
cbOutputData | Dimensioni del buffer a cui punta pOutputData |
pcbOutputNeeded | Indirizzo di un DWORD contenente il numero di byte necessari per il buffer a cui punta pOutputData |
XcvData restituisce NO_ERROR se può ottenere l'indirizzo IP della stampante. Se cbOutputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeeded è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded è diverso da NULL. Se pOutputData è NULL, la funzione restituisce ERROR_INVALID_PARAMETER.
Comando MonitorUI
Il comando MonitorUI ottiene il nome della DLL dell'interfaccia utente di monitoraggio della porta che fornisce un'interfaccia a TCPMON.
Parametro XcvData | Valore |
---|---|
pszDataName | L"MonitorUI" |
pInputData | NULL |
cbInputData | 0 |
pOutputData | Indirizzo di un buffer che riceve il nome della DLL dell'interfaccia utente di Monitoraggio porte |
cbOutputData | Numero di byte nella stringa contenente il nome della DLL dell'interfaccia utente di Monitoraggio porte |
pcbOutputNeeded | Indirizzo di un DWORD contenente il numero di byte necessari per il buffer a cui punta pOutputData |
XcvData restituisce NO_ERROR se è in grado di ottenere il nome della DLL dell'interfaccia utente. Oltre ai normali codici di errore, XcvData restituisce ERROR_ACCESS_DENIED se il chiamante dispone di privilegi insufficienti nel server. Questo comando richiede SERVER_ACCESS_ADMINISTER privilegio. Se cbOutputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeeded è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded è diverso da NULL. Se pOutputData è NULL, la funzione restituisce ERROR_INVALID_PARAMETER.
SNMPCommunity
Il comando SNMPCommunity ottiene il nome della community SNMP (Simple Network Management Protocol) per una stampante.
Parametro XcvData | Valore |
---|---|
pszDataName | L"SNMPCommunity" |
pInputData | NULL |
cbInputData | 0 |
pOutputData | Indirizzo di un buffer che riceve una stringa contenente la community SNMP della stampante |
cbOutputData | Dimensione del buffer necessaria per contenere la stringa a cui punta il parametro pOutputData |
pcbOutputNeeded | Indirizzo di un DWORD contenente il numero di byte necessari per il buffer a cui punta pOutputData |
XcvData restituisce NO_ERROR se può ottenere il nome della community SNMP della stampante. Se cbOutputData è inferiore a quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeeded è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeeded è diverso da NULL. Se pOutputData è NULL, la funzione restituisce ERROR_INVALID_PARAMETER.
SNMPDeviceIndex
Il comando SNMPDeviceIndex ottiene l'indice del dispositivo SNMP (Simple Network Management Protocol) della stampante.
Parametro XcvData | Valore |
---|---|
pszDataName | L"SNMPDeviceIndex" |
pInputData | NULL |
cbInputData | 0 |
pOutputData | Indirizzo di un buffer che riceve l'indice del dispositivo |
cbOutputData | sizeof(DWORD) |
pcbOutputNeeded | Indirizzo di una DWORD contenente sizeof(DWORD) |
XcvData restituisce NO_ERROR se può ottenere l'indice del dispositivo SNMP della stampante. Se cbOutputData è minore di quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeed è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeed è non NULL. Se pOutputData è NULL, la funzione restituisce ERROR_INVALID_PARAMETER.
SNMPEnabled
Il comando SNMPEnabled determina se il protocollo SNMP (Simple Network Management Protocol) è abilitato per il dispositivo corrente.
Parametro XcvData | Valore |
---|---|
pszDataName | L"SNMPEnabled" |
pInputData | NULL |
cbInputData | 0 |
pOutputData | Indirizzo di un buffer che riceve un valore DWORD |
cbOutputData | sizeof(DWORD) |
pcbOutputNeeded | Indirizzo di una DWORD contenente sizeof(DWORD) |
XcvData restituisce NO_ERROR se SNMP è abilitato per il dispositivo. Se cbOutputData è minore di quello richiesto, la funzione restituisce ERROR_INVALID_PARAMETER quando pcbOutputNeed è NULL e ERROR_INSUFFICIENT_BUFFER quando pcbOutputNeed è non NULL. Se pOutputData è NULL, la funzione restituisce ERROR_INVALID_PARAMETER.