TCPMON Xcv-Befehle
In diesem Abschnitt werden die Befehle beschrieben, die in einem Aufruf der XcvData - oder XcvDataPort-Funktion bei der Kommunikation mit dem TCP/IP-Standardportmonitor (TCPMON) angegeben werden können. Jeder Befehl wird durch die pszDataName-Zeichenfolge im Aufruf dieser Funktionen angegeben. Für bestimmte Befehle ist ein Eingabepuffer oder ein Ausgabepuffer oder beides erforderlich. Die Parameter pInputData und pOutputData dieser Funktionen enthalten die Adressen dieser Puffer.
Die Tabelle, die in der Beschreibung der folgenden Befehle angezeigt wird, enthält die Parameter XcvData und XcvDataPort , die mit den Befehlen verwendet werden. Beachten Sie, dass der hXcv-Parameter (der für beide Funktionen gemeinsam ist) nicht aufgeführt ist, ebenso wenig wie der pdwStatus-Parameter der XcvData-Funktion.
AddPort-Befehl
Der Befehl AddPort fügt einen TCP/IP-Standardport hinzu, der entweder ein LPR-Port oder ein RAW-TCP/IP-Port sein kann.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"AddPort" |
| pInputData | Adresse einer PORT_DATA_1-Struktur |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeed | Adresse eines DWORD |
XcvData gibt NO_ERROR zurück, wenn der Port hinzugefügt werden kann. Zusätzlich zu den normalen Fehlercodes gibt XcvData ERROR_ACCESS_DENIED zurück, wenn der Benutzer nicht über ausreichende Berechtigungen zum Erstellen eines Ports auf dem Server verfügt. Für diesen Befehl ist SERVER_ACCESS_ADMINISTER Berechtigung erforderlich. Wenn der pInputData-ParameterNULL ist, gibt die Funktion ERROR_INVALID_DATA zurück. Wenn pInputData-->dwVersion nicht gleich 1 ist, gibt die Funktion ERROR_INVALID_LEVEL zurück.
ConfigPort-Befehl
Mit dem Befehl ConfigPort wird ein vorhandener TCP/IP-Standardportport für den Monitor konfiguriert.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"ConfigPort" |
| pInputData | Adresse einer PORT_DATA_1-Struktur |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeed | Adresse eines DWORD |
XcvData gibt NO_ERROR zurück, wenn der Port konfiguriert werden kann. Zusätzlich zu den normalen Fehlercodes gibt XcvData ERROR_ACCESS_DENIED zurück, wenn der Aufrufer nicht über ausreichende Berechtigungen zum Ausführen der Anforderung verfügt. Für diesen Befehl ist SERVER_ACCESS_ADMINISTER Berechtigung erforderlich. Wenn der pInputData-ParameterNULL ist oder der Wert in cbInputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_DATA zurück. Wenn pInputData-->dwVersion nicht gleich 1 ist, gibt die Funktion ERROR_INVALID_LEVEL zurück.
DeletePort-Befehl
Der Befehl DeletePort löscht einen Port aus dem TCP/IP-Standardportmonitor.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"DeletePort" |
| pInputData | Adresse der DELETE_PORT_DATA_1 Struktur |
| cbInputData | sizeof(DELETE_PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeed | Adresse eines DWORD |
XcvData gibt NO_ERROR zurück, wenn der Port erfolgreich gelöscht wurde. Zusätzlich zu den normalen Fehlercodes gibt XcvData ERROR_ACCESS_DENIED zurück, wenn der Aufrufer über unzureichende Berechtigungen auf dem Server verfügt. Für diesen Befehl ist SERVER_ACCESS_ADMINISTER Berechtigung erforderlich. Wenn der pInputData-ParameterNULL ist oder der cbInputData-Parameter kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_DATA zurück. Wenn pInputData-->dwVersion nicht gleich 1 ist, gibt die Funktion ERROR_INVALID_LEVEL zurück.
GetConfigInfo-Befehl
Der Befehl GetConfigInfo ruft die Konfigurationsinformationen eines bestimmten Ports ab. In diesem Fall muss das Xcv-Datenhandle auf einen bestimmten TCP/IP-Standardport-Monitorport verweisen, damit der Port identifiziert werden kann.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"GetConfigInfo" |
| pInputData | Adresse einer CONFIG_INFO_DATA_1-Struktur |
| cbInputData | sizeof(CONFIG_INFO_DATA_1) |
| pOutputData | Adresse einer PORT_DATA_1-Struktur |
| cbOutputData | sizeof(PORT_DATA_1) |
| pcbOutputNeed | Adresse eines DWORD mit der Anzahl von Bytes, die für den Puffer benötigt werden, auf den pOutputData verweist |
XcvData gibt NO_ERROR zurück, wenn die Konfigurationsinformationen für den Port abgerufen werden können. Wenn pInputDataNULL ist oder cbInputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_DATA zurück. Wenn pInputData-->dwVersion nicht gleich 1 ist, gibt die Funktion ERROR_INVALID_LEVEL zurück. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeededNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist.
HostAddress-Befehl
Der HostAddress-Befehl ruft den Hostnamen des Druckers ab.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"HostAddress" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse eines Puffers, der eine Zeichenfolge mit dem Hostnamen des Druckers empfängt |
| cbOutputData | Größe des Puffers, auf den pOutputData verweist |
| pcbOutputNeed | Adresse eines DWORD mit der Anzahl von Bytes, die für den Puffer benötigt werden, auf den pOutputData verweist |
XcvData gibt NO_ERROR zurück, wenn der Name des Druckerhosts abgerufen werden kann. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeededNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist. Wenn pOutputDataNULL ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück.
IPAddress-Befehl
Der Befehl IPAddress ruft die IP-Adresse des Druckers ab.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"IPAddress" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse eines Puffers, der eine Zeichenfolge mit der IP-Adresse des Druckers empfängt |
| cbOutputData | Größe des Puffers, auf den pOutputData verweist |
| pcbOutputNeed | Adresse eines DWORD mit der Anzahl von Bytes, die für den Puffer benötigt werden, auf den pOutputData verweist |
XcvData gibt NO_ERROR zurück, wenn die IP-Adresse des Druckers abgerufen werden kann. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeededNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist. Wenn pOutputDataNULL ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück.
MonitorUI-Befehl
Der Befehl MonitorUI ruft den Namen der Portmonitor-UI-DLL ab, die eine Schnittstelle zu TCPMON bereitstellt.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"MonitorUI" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse eines Puffers, der den Namen der Benutzeroberflächen-DLL des Portmonitors empfängt |
| cbOutputData | Anzahl der Bytes in der Zeichenfolge, die den Namen der Benutzeroberflächen-DLL des Portmonitors enthält |
| pcbOutputNeed | Adresse eines DWORD mit der Anzahl von Bytes, die für den Puffer benötigt werden, auf den pOutputData verweist |
XcvData gibt NO_ERROR zurück, wenn der Name der Benutzeroberflächen-DLL abgerufen werden kann. Zusätzlich zu den normalen Fehlercodes gibt XcvData ERROR_ACCESS_DENIED zurück, wenn der Aufrufer über unzureichende Berechtigungen auf dem Server verfügt. Für diesen Befehl ist SERVER_ACCESS_ADMINISTER Berechtigung erforderlich. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeededNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist. Wenn pOutputDataNULL ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück.
SNMPCommunity
Der SNMPCommunity-Befehl ruft den SNMP-Communitynamen (Simple Network Management Protocol) für einen Drucker ab.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"SNMPCommunity" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse eines Puffers, der eine Zeichenfolge empfängt, die die SNMP-Community des Druckers enthält |
| cbOutputData | Größe des Puffers, der erforderlich ist, um die Zeichenfolge zu enthalten, auf die der pOutputData-Parameter verweist |
| pcbOutputNeed | Adresse eines DWORD mit der Anzahl von Bytes, die für den Puffer benötigt werden, auf den pOutputData verweist |
XcvData gibt NO_ERROR zurück, wenn der SNMP-Communityname des Druckers abgerufen werden kann. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeededNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist. Wenn pOutputDataNULL ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück.
SNMPDeviceIndex
Der SnmpDeviceIndex-Befehl ruft den SNMP-Geräteindex (Simple Network Management Protocol) des Druckers ab.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"SNMPDeviceIndex" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse eines Puffers, der den Geräteindex empfängt |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeed | Adresse eines DWORD-Werts, der sizeof(DWORD) enthält |
XcvData gibt NO_ERROR zurück, wenn der SNMP-Geräteindex des Druckers abgerufen werden kann. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeedEDNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist. Wenn pOutputDataNULL ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück.
SNMPEnabled
Der SNMPEnabled-Befehl bestimmt, ob das Simple Network Management Protocol (SNMP) für das aktuelle Gerät aktiviert ist.
| XcvData-Parameter | Wert |
|---|---|
| pszDataName | L"SNMPEnabled" |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse eines Puffers, der einen DWORD-Wert empfängt |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeed | Adresse eines DWORD-Werts, der sizeof(DWORD) enthält |
XcvData gibt NO_ERROR zurück, wenn SNMP für das Gerät aktiviert ist. Wenn cbOutputData kleiner als erforderlich ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück, wenn pcbOutputNeedEDNULL ist, und ERROR_INSUFFICIENT_BUFFER, wenn pcbOutputNeeded nicht NULL ist. Wenn pOutputDataNULL ist, gibt die Funktion ERROR_INVALID_PARAMETER zurück.