Sm_PolicyApi_GetAgentTypeAttrByName()

Returns an agent type attribute object by name.
sm1252sp1
Returns an agent type attribute object by name.
Type
Agent function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetAgentTypeAttrByName (
void*pSessionHandle,
const char*szAgentTypeName,
Sm_PolicyApi_AgentTypeAttr_t**ppstructAgentTypeAttr
);
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.
szAgentTypeName
I
A null-terminated string containing the name of an existing agent type attribute.
ppstructAgentTypeAttr
O
The address of a pointer to an agent type attribute structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated for Sm_PolicyApi_AgentTypeAttr_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 or an agent type attribute.
  • Sm_PolicyApi_NotFound. An agent type attribute with the specified name was not found.