SnmpGetVb function (winsnmp.h)
[SNMP is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use Windows Remote Management, which is the Microsoft implementation of WS-Man.]
A WinSNMP application calls the SnmpGetVb function to retrieve information from a variable bindings list. This WinSNMP function retrieves a variable name and its associated value from the variable binding entry specified by the index parameter.
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetVb( HSNMP_VBL vbl, smiUINT32 index, smiLPOID name, smiLPVALUE value );
Handle to the variable bindings list to retrieve.
Specifies an unsigned long integer variable that identifies the variable binding entry to retrieve. This variable contains the position of the variable binding entry, within the variable bindings list.
Valid values for this parameter are in the range from 1 to n, where 1 indicates the first variable binding entry in the variable bindings list, and n is the total number of entries in the list. For additional information, see the following Remarks section.
Pointer to an smiOID structure to receive the variable name of the variable binding entry.
Pointer to an smiVALUE structure to receive the value associated with the variable identified by the name parameter.
If the function succeeds, the syntax member of the structure pointed to by the value parameter can be one of the following syntax data types. For additional information, see RFC 1902, "Structure of Management Information for Version 2 of the Simple Network Management Protocol (SNMPv2)."
If the function succeeds, the return value is SNMPAPI_SUCCESS.
If the function fails, the return value is SNMPAPI_FAILURE. To get extended error information, call SnmpGetLastError. The SnmpGetLastError function can return one of the following errors.
||The SnmpStartup function did not complete successfully.|
||An error occurred during memory allocation.|
||The index parameter is invalid.|
||The vbl parameter is invalid.|
||An unknown or undefined error occurred.|
The last three syntax types describe exception conditions under the SNMP version 2C(SNMPv2C) framework.
The SnmpGetVb function returns the variable name of the variable binding entry in the structure pointed to by the name parameter. It returns the variable's associated value in the structure pointed to by the value parameter.
On input, the SnmpGetVb function ignores the members of the smiOID and smiVALUE structures pointed to by the name and value parameters respectively. The Microsoft WinSNMP implementation overwrites the members if the function completes successfully.
Valid values for a WinSNMP application to use for the index parameter are as follows:
- The return value from a call to the SnmpCountVbl function
- The error index field of an SNMP_PDU_RESPONSE protocol data unit (PDU) returned by a call to the SnmpRecvMsg function
|Minimum supported client||Windows 2000 Professional [desktop apps only]|
|Minimum supported server||Windows 2000 Server [desktop apps only]|