WinSNMP Function Return Values

[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.]

The return value from a WinSNMP function call can be a handle to a resource that the Microsoft WinSNMP implementation allocates for the WinSNMP application.

The following table lists the five types of resource handles that the implementation allocates.

SymbolicCodeDescription
HSNMP_SESSIONHandle to a WinSNMP session
HSNMP_ENTITYHandle to an SNMP entity
HSNMP_CONTEXTHandle to an SNMP context
HSNMP_PDUHandle to a protocol data unit
HSNMP_VBLHandle to a variable binding list
SNMPAPI_FAILUREIndicates an error. Equates to 0 or NULL .
SNMPAPI_SUCCESSIndicates the function completed successfully. Equates to 1 or a positive count.
7 entries

Article text from the Win32 documentation (opens in a new tab), by Microsoft, under the CC BY 4.0 (opens in a new tab) licence.