SnmpFreePdu 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 SnmpFreePdu function releases resources associated with an SNMP protocol data unit (PDU) created by the SnmpCreatePdu or the SnmpDuplicatePdu function.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpFreePdu(
  [in] HSNMP_PDU PDU
);

Parameters

[in] PDU

Handle to the SNMP PDU to free.

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

If the application calls the SnmpClose or the SnmpCleanup function, the Microsoft WinSNMP implementation frees all resources it allocates for the WinSNMP session. However, it is recommended that the application free individual resources with the WinSNMP function that corresponds to the resource. This reduces the implementation's work load, and should enhance the implementation's service to all applications. The application should use the SnmpFreeVbl function to deallocate variable bindings list resources. For additional information, see WinSNMP Data Management Concepts.

Under WinSNMP, a variable binding entry exists only within a variable bindings list, even if the variable bindings list contains just one entry.

Requirements

See also

SnmpCleanup

SnmpClose

SnmpFreeVbl

WinSNMP Functions

WinSNMP API Overview