Sm_PolicyApi_GetAgent()

Gets the contents of the agent identified by pszAgentOid. The results of this function are returned in a structure referenced by ppstructAgent.
casso126
Gets the contents of the agent identified by
pszAgentOid
. The results of this function are returned in a structure referenced by
ppstructAgent
.
Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Agent function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetAgent (
void*pSessionHandle,
const char*pszAgentOid,
Sm_PolicyApi_Agent_t**ppstructAgent
);
Parameter
I/O
Description
pSessionHandle
I
A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszAgentOid
I
A null-terminated string containing the object identifier of an existing agent.
ppstructAgent
O
The address of a pointer to an agent structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Agent_t.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get an agent.
  • Sm_PolicyApi_InvalidOid. An agent with the specified OID not found.