Sm_PolicyApi_GetAgentTypeByName()
Gets the contents of the agent type object identified by pszAgentTypeName. The results of this function will be returned in a structure referenced by ppstructAgentType.
casso126
Gets the contents of the agent type object identified by
pszAgentTypeName
. The results of this function will be returned in a structure referenced by ppstructAgentType
.Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Agent function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetAgentTypeByName (void*pSessionHandle,const char*pszAgentTypeName,Sm_PolicyApi_AgentType_t**ppstructAgentType);
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. |
pszAgentTypeName
| I | A null-terminated string containing the name of an existing agent type. |
ppstructAgentType
| O | The address of a pointer to an agent type structure. |
Returns
- Sm_PolicyApi_Success. The get operation was successful.
- Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_AgentType_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 type.
- Sm_PolicyApi_NotFound.An agent type with the specified name was not found.