Sm_PolicyApi_GetVariableTypeByName()

Gets a specified variable type.
casso127
Gets a specified variable type.
The results of this function are returned in a structure referenced by
ppstructVariable
. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Variable function.
Syntax
int SM_EXTERN Sm_PolicyApi_GetVariableTypeByName (
void*pSessionHandle,
const char*pszVariableTypeName,
Sm_PolicyApi_VariableType_t**ppstructVariableType
);
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.
pszVariableName
I
Unique name that corresponds to a variable type.
ppstructVariable
O
The address of a pointer to a variable structure.
Returns
  • Sm_PolicyApi_Success. The get was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Variable_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 obtain the variable type.
  • Sm_PolicyApi_NotFound The variable type object identifier was not found.
  • Sm_PolicyApi_FeatureNotSupported. The client who called this function initialized the API with a version less than SM_POLICY_API_VERSION_6_0.