Sm_AgentApi_UnInit()

Programming Guides › Programming Guide for C › Guidance for the Agent API in C › Agent API Function Declarations (C) › Sm_AgentApi_UnInit()

Sm_AgentApi_UnInit()

Once the agent is no longer needed, uninitialize all API instances by issuing the Sm_AgentApi_UnInit() call for each API instance. This closes TCP connections to all Policy Servers.

This function does not deallocate memory. It is your responsibility to deallocate any memory you allocated for your custom agent.

Syntax

int SM_EXTERN Sm_AgentApi_UnInit (
   void** ppHandle
);

Parameter	I/O	Description
ppHandle	I	The address of a pointer to the handle for this API session. This is an opaque type.

Returns

SM_AGENTAPI_SUCCESS. Uninitialization succeeded.
SM_AGENTAPI_NOCONNECTION. Uninitialization was not done.

Example

See the function SmAgentExample::Sm_UnInit() in the example application smagentexample.cpp.