Sm_PolicyApi_GetGlobalResponseByName()

Gets the specified global response.
sm1252sp1
Gets the specified global response.
The results of this function are returned in a structure referenced by
ppstructResponse
.
Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Administrator function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetGlobalResponseByName (
void*pHandle,
const char*szResponseName,
Sm_PolicyApi_Response_t**ppstructReponse
);
Parameter
I/O
Description
pHandle
I
A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
szResponseName
I
Unique name that corresponds to a global response.
ppstructResponse
O
The address of a pointer to a response structure.
Returns
  • Sm_PolicyApi_Success. The get operation was successful.
  • Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_Response_t.
  • 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 get a scheme.
  • Sm_PolicyApi_NotFound. The global response name was not found.