snmpFreeAuthCB_v3()--SNMP Version 3 Free Authentication Control Block
Syntax
#include <qtomeapi.h> int snmpGet_v3(snmp_auth_cb &my_auth_cb);
Service Program Name: QTOMEAPI
Default Public Authority: *USE
Threadsafe: No
An SNMP managing application uses the snmpFreeAuthCB_v3() function to free the authentication related information about a remote or local SNMP version 3 (SNMPv3) agent.
Parameters
- &my_auth_cb
- (Input/Output) The address of an SNMPv3 authentication control block built by the snmpDiscover_v3() function.
Authorities
- Service Program Authority
- *USE
Return Value
The following are the possible return codes posted by the snmpFreeAuthCB_v3() function:
0 | API_RC_OK
snmpFreeAuthCB_v3() was successful. |
-118 | API_RC_INVALID_AUTH_CB_PTR
The pointer value to the authentication control block must be non-NULL. |
-117 | API_RC_INVALID_AUTH_CB
The authorization control block is not valid. |
-202 | API_RC_NOT_OK
The APIs have detected an unknown error and cannot continue. |
241 | API_RC_DOMAIN_ERROR
This is equivalent to an MCH6801 error--stating object domain error. |
242 | API_RC_INVALID_POINTER
This is equivalent to an MCH3601 error--referenced location in a space does not contain a pointer. |
243 | API_RC_INVALID_PTR_TYPE
This is equivalent to an MCH3602 error-pointer type not valid for requested operation. |
For more information, see the Simple Network Management Protocol (SNMP) Support manual.
Usage Notes
This API should be called before the manager ends or after all communication ends with an SNMP agent. It should be called for each control block that was created by the snmpDiscover_v3 function.
Related Information
- The <qtomeapi.h> file (see Header
Files for UNIX®-Type Functions)
- snmpGet()--Retrieve MIB Objects
- snmpGetnext()--Retrieve Next MIB Object
- snmpSet()--Set MIB Objects
- snmpDiscover_v3()--SNMP Version 3 Discovery
- snmpGet_v3()--Retrieve MIB Objects Using SNMP Version 3
- snmpGetnext_v3()--Retrieve Next MIB Object Using SNMP Version 3
- snmpSet_v3()--Set MIB Objects Using SNMP Version 3
Example
For examples that pertain to the SNMP manager APIs, see Using SNMP Manager APIs--Example.
API introduced: V7R2
Top | UNIX-Type APIs | APIs by category |