[This is preliminary documentation and subject to change.]
The WinSNMP SnmpFreeEntity function releases resources associated with an SNMP management entity.
SNMPAPI_STATUS SnmpFreeEntity(
HSNMP_ENTITY entity // handle to the entity to release
);
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.
| Error Code | Description |
|---|---|
| SNMPAPI_NOT_INITIALIZED | The SnmpStartup function did not complete successfully. |
| SNMPAPI_ALLOC_ERROR | An error occurred during memory allocation. |
| SNMPAPI_ENTITY_INVALID | The entity parameter is invalid. |
| SNMPAPI_OTHER_ERROR | An unknown or undefined error occurred. |
When the WinSNMP manager 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 manager application free individual resources by using the WinSNMP function that corresponds to the resource. For example, manager applications should call the SnmpFreeEntity function to release resources allocated by a call to the SnmpStrToEntity function. This reduces the implementation's work load, and should enhance the implementation's service to all applications.
For additional information, see WinSNMP Data Management Concepts.
Windows NT: Requires version 5.0 or later. Available as a redistributable for Windows NT 4.0.
Windows: Unsupported.
Windows CE: Unsupported.
Header: Declared in winsnmp.h.
Import Library: Use wsnmp32.lib.
WinSNMP Manager API Overview, WinSNMP Functions, SnmpClose, SnmpCleanup, SnmpStrToEntity