Sm_PolicyApi_DeleteAgent()

Deletes the agent identified by pszAgentOid.
sm1252sp1
Deletes the agent identified by
pszAgentOid
.
Type
Agent function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_DeleteAgent (
void*pSessionHandle,
const char*pszAgentOid
);
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.
Returns
  • Sm_PolicyApi_Success. The agent was deleted successfully.
  • Sm_PolicyApi_Failure. The agent was not deleted successfully.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to delete an agent.
  • Sm_PolicyApi_InvalidOid. An agent with the specified OID was not found.