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

The WinSNMP SnmpFreeContext function releases resources associated with an SNMP context, which is a set of managed object resources.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpFreeContext(
  [in] HSNMP_CONTEXT context
);

Parameters

[in] context

Handle to the SNMP context that will have its resources released.

Return value

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 specifying a NULL value in its session parameter. The SnmpGetLastError function can return one of the following errors.

Remarks

When the WinSNMP application calls the SnmpClose function or the SnmpCleanup function, the Microsoft WinSNMP implementation frees all resources it allocated for the WinSNMP session. However, it is recommended that the WinSNMP application free individual resources with the WinSNMP function that corresponds to the resource. For example, applications should call the SnmpFreeContext function to release resources allocated by a call to the SnmpStrToContext function. This reduces the implementation's work load, and should enhance the service of the implementation to all applications.

For additional information, see WinSNMP Data Management Concepts.

Requirements

See also

SnmpCleanup

SnmpClose

SnmpStrToContext

WinSNMP Functions

WinSNMP API Overview