Commandes TCPMON Xcv
Cette section décrit les commandes qui peuvent être spécifiées dans un appel à la fonction XcvData ou XcvDataPort , lorsqu’elle communique avec le moniteur de port TCP/IP (TCPMON) standard. Chaque commande est spécifiée par la chaîne pszDataName dans l’appel à ces fonctions. Certaines commandes nécessitent une mémoire tampon d’entrée, une mémoire tampon de sortie, ou les deux. Les paramètres pInputData et pOutputData de ces fonctions contiennent les adresses de ces mémoires tampons.
Le tableau qui apparaît dans la description de chacune des commandes suivantes répertorie les paramètres XcvData et XcvDataPort utilisés avec les commandes. Notez que le paramètre hXcv (commun aux deux fonctions) n’est pas répertorié, ni le paramètre pdwStatus de la fonction XcvData.
Commande AddPort
La commande AddPort ajoute un port TCP/IP standard, qui peut être un port LPR ou un port TCP/IP RAW.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"AddPort » |
| pInputData | Adresse d’une structure de PORT_DATA_1 |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeeded | Adresse d’un DWORD |
XcvData retourne NO_ERROR s’il peut ajouter le port. En plus des codes d’erreur normaux, XcvData retourne ERROR_ACCESS_DENIED si l’utilisateur dispose de privilèges insuffisants pour créer un port sur le serveur. Cette commande nécessite SERVER_ACCESS_ADMINISTER privilège. Si le paramètre pInputData a la valeur NULL, la fonction retourne ERROR_INVALID_DATA. Si pInputData-->dwVersion n’est pas égal à 1, la fonction retourne ERROR_INVALID_LEVEL.
Commande ConfigPort
La commande ConfigPort configure un port de surveillance de port TCP/IP standard existant.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"ConfigPort » |
| pInputData | Adresse d’une structure de PORT_DATA_1 |
| cbInputData | sizeof(PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeeded | Adresse d’un DWORD |
XcvData retourne NO_ERROR s’il peut configurer le port. En plus des codes d’erreur normaux, XcvData retourne ERROR_ACCESS_DENIED si l’appelant dispose de privilèges insuffisants pour effectuer la requête. Cette commande nécessite SERVER_ACCESS_ADMINISTER privilège. Si le paramètre pInputData a la valeur NULL ou si la valeur dans cbInputData est inférieure à celle requise, la fonction retourne ERROR_INVALID_DATA. Si pInputData-->dwVersion n’est pas égal à 1, la fonction retourne ERROR_INVALID_LEVEL.
DeletePort, commande
La commande DeletePort supprime un port du moniteur de port TCP/IP standard.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"DeletePort » |
| pInputData | Adresse de DELETE_PORT_DATA_1 structure |
| cbInputData | sizeof(DELETE_PORT_DATA_1) |
| pOutputData | NULL |
| cbOutputData | 0 |
| pcbOutputNeeded | Adresse d’un DWORD |
XcvData retourne NO_ERROR si le port est correctement supprimé. En plus des codes d’erreur normaux, XcvData retourne ERROR_ACCESS_DENIED si l’appelant a des privilèges insuffisants sur le serveur. Cette commande nécessite SERVER_ACCESS_ADMINISTER privilège. Si le paramètre pInputData a la valeur NULL ou si le paramètre cbInputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_DATA. Si pInputData-->dwVersion n’est pas égal à 1, la fonction retourne ERROR_INVALID_LEVEL.
Commande GetConfigInfo
La commande GetConfigInfo obtient les informations de configuration d’un port particulier. Dans ce cas, le handle de données Xcv doit pointer vers un port de surveillance de port TCP/IP standard particulier afin que le port puisse être identifié.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"GetConfigInfo » |
| pInputData | Adresse d’une structure de CONFIG_INFO_DATA_1 |
| cbInputData | sizeof(CONFIG_INFO_DATA_1) |
| pOutputData | Adresse d’une structure de PORT_DATA_1 |
| cbOutputData | sizeof(PORT_DATA_1) |
| pcbOutputNeeded | Adresse d’un DWORD contenant le nombre d’octets nécessaires pour la mémoire tampon pointée par pOutputData |
XcvData retourne NO_ERROR s’il peut obtenir les informations de configuration du port. Si pInputData a la valeur NULL ou si cbInputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_DATA. Si pInputData-->dwVersion n’est pas égal à 1, la fonction retourne ERROR_INVALID_LEVEL. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded a une valeur non NULL.
Commande HostAddress
La commande HostAddress obtient le nom d’hôte de l’imprimante.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"HostAddress » |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse d’une mémoire tampon qui reçoit une chaîne contenant le nom d’hôte de l’imprimante |
| cbOutputData | Taille de la mémoire tampon pointée par pOutputData |
| pcbOutputNeeded | Adresse d’un DWORD contenant le nombre d’octets nécessaires pour la mémoire tampon pointée par pOutputData |
XcvData retourne NO_ERROR s’il peut obtenir le nom de l’hôte de l’imprimante. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded a une valeur non NULL. Si pOutputData a la valeur NULL, la fonction retourne ERROR_INVALID_PARAMETER.
Commande IPAddress
La commande IPAddress obtient l’adresse IP de l’imprimante.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"IPAddress » |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse d’une mémoire tampon qui reçoit une chaîne contenant l’adresse IP de l’imprimante |
| cbOutputData | Taille de la mémoire tampon pointée par pOutputData |
| pcbOutputNeeded | Adresse d’un DWORD contenant le nombre d’octets nécessaires pour la mémoire tampon pointée par pOutputData |
XcvData retourne NO_ERROR s’il peut obtenir l’adresse IP de l’imprimante. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded a une valeur non NULL. Si pOutputData a la valeur NULL, la fonction retourne ERROR_INVALID_PARAMETER.
Commande MonitorUI
La commande MonitorUI obtient le nom de la DLL d’interface utilisateur du moniteur de port qui fournit une interface à TCPMON.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"MonitorUI » |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse d’une mémoire tampon qui reçoit le nom de la DLL de l’interface utilisateur du moniteur de port |
| cbOutputData | Nombre d’octets dans la chaîne contenant le nom de la DLL de l’interface utilisateur du moniteur de port |
| pcbOutputNeeded | Adresse d’un DWORD contenant le nombre d’octets nécessaires pour la mémoire tampon pointée par pOutputData |
XcvData retourne NO_ERROR s’il est en mesure d’obtenir le nom de la DLL d’interface utilisateur. En plus des codes d’erreur normaux, XcvData retourne ERROR_ACCESS_DENIED si l’appelant a des privilèges insuffisants sur le serveur. Cette commande nécessite SERVER_ACCESS_ADMINISTER privilège. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded a une valeur non NULL. Si pOutputData a la valeur NULL, la fonction retourne ERROR_INVALID_PARAMETER.
SNMPCommunity
La commande SNMPCommunity obtient le nom de communauté SNMP (Simple Network Management Protocol) pour une imprimante.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"SNMPCommunity » |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse d’une mémoire tampon qui reçoit une chaîne contenant la communauté SNMP de l’imprimante |
| cbOutputData | Taille de la mémoire tampon nécessaire pour contenir la chaîne pointée par le paramètre pOutputData |
| pcbOutputNeeded | Adresse d’un DWORD contenant le nombre d’octets nécessaires pour la mémoire tampon pointée par pOutputData |
XcvData retourne NO_ERROR s’il peut obtenir le nom de la communauté SNMP de l’imprimante. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded a une valeur non NULL. Si pOutputData a la valeur NULL, la fonction retourne ERROR_INVALID_PARAMETER.
SNMPDeviceIndex
La commande SNMPDeviceIndex obtient l’index de périphérique SNMP (Simple Network Management Protocol) de l’imprimante.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"SNMPDeviceIndex » |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse d’une mémoire tampon qui reçoit l’index de l’appareil |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeeded | Adresse d’un DWORD qui contient sizeof(DWORD) |
XcvData retourne NO_ERROR s’il peut obtenir l’index de périphérique SNMP de l’imprimante. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded est non NULL. Si pOutputData a la valeur NULL, la fonction retourne ERROR_INVALID_PARAMETER.
SNMPEnabled
La commande SNMPEnabled détermine si le protocole SNMP (Simple Network Management Protocol) est activé pour l’appareil actuel.
| Paramètre XcvData | Valeur |
|---|---|
| pszDataName | L"SNMPEnabled » |
| pInputData | NULL |
| cbInputData | 0 |
| pOutputData | Adresse d’une mémoire tampon qui reçoit une valeur DWORD |
| cbOutputData | sizeof(DWORD) |
| pcbOutputNeeded | Adresse d’un DWORD qui contient sizeof(DWORD) |
XcvData retourne NO_ERROR si SNMP est activé pour l’appareil. Si cbOutputData est plus petit que nécessaire, la fonction retourne ERROR_INVALID_PARAMETER lorsque pcbOutputNeeded a la valeur NULL et ERROR_INSUFFICIENT_BUFFER lorsque pcbOutputNeeded est non NULL. Si pOutputData a la valeur NULL, la fonction retourne ERROR_INVALID_PARAMETER.