Funzione SnmpEntityToStr (winsnmp.h)
[SNMP è disponibile per l'uso nei sistemi operativi specificati nella sezione Requisiti. È possibile che in versioni successive sia stata modificata o non sia più disponibile. Usare invece Gestione remota Windows, ovvero l'implementazione Microsoft di WS-Man.
La funzione WinSNMP SnmpEntityToStr restituisce una stringa che identifica un'entità di gestione SNMP.
Sintassi
SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
[in] HSNMP_ENTITY entity,
[in] smiUINT32 size,
[out] LPSTR string
);
Parametri
[in] entity
Gestire l'entità di gestione SNMP di interesse.
[in] size
Specifica le dimensioni, in byte, del buffer a cui punta il parametro stringa . L'applicazione WinSNMP deve allocare un buffer sufficientemente grande da contenere la stringa di output.
[out] string
Puntatore a un buffer per ricevere la stringa con terminazione Null che identifica l'entità di gestione SNMP di interesse.
Valore restituito
Se la funzione ha esito positivo, il valore restituito è il numero di byte, incluso un byte null di terminazione, che SnmpEntityToStr restituisce nel buffer di stringhe . Questo valore può essere minore o uguale al valore del parametro size , ma non può essere maggiore.
Se la funzione ha esito negativo, il valore restituito viene SNMPAPI_FAILURE. Per ottenere informazioni estese sull'errore, chiamare SnmpGetLastError. La funzione SnmpGetLastError può restituire uno degli errori seguenti.
Codice restituito | Descrizione |
---|---|
|
La funzione SnmpStartup non è stata completata correttamente. |
|
Errore durante l'allocazione della memoria. |
|
Il parametro di entità non è valido. |
|
La lunghezza del buffer di output non è sufficiente. |
|
Si è verificato un errore sconosciuto o non definito. |
Commenti
L'impostazione corrente della modalità di conversione dell'entità e del contesto determina il tipo di stringa di output SnmpEntityToStr restituisce. Per altre informazioni, vedere Supporto per le stringhe di indirizzi IPX in WinSNMP e Impostazione della modalità di conversione dell'entità e del contesto.
Quando la modalità di conversione dell'entità e del contesto è SNMPAPI_TRANSLATED e nel database dell'implementazione è presente una voce, l'implementazione restituisce il nome descrittivo associato dell'entità di gestione. Se non esiste una voce per l'entità di gestione, SnmpEntityToStr restituisce l'indirizzo di trasporto SNMP letterale dell'entità di gestione.
Quando la modalità di conversione dell'entità e del contesto è SNMPAPI_UNTRANSLATED_V1 o SNMPAPI_UNTRANSLATED_V2, l'implementazione di Microsoft WinSNMP restituisce anche l'indirizzo di trasporto SNMP letterale dell'entità di gestione.
Requisiti
Requisito | Valore |
---|---|
Client minimo supportato | Windows 2000 Professional [solo app desktop] |
Server minimo supportato | Windows 2000 Server [solo app desktop] |
Piattaforma di destinazione | Windows |
Intestazione | winsnmp.h |
Libreria | Wsnmp32.lib |
DLL | Wsnmp32.dll |