Sm_PolicyApi_GetGlobalRuleByName()
Gets the specified global rule.
casso127
Gets the specified global rule.
The results of this function are returned in a structure referenced by
ppstructRule
.Free the memory allocated for this structure by calling Sm_PolicyApi_FreeMemoryEx().
Type
Administrator function, global scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetGlobalRuleByName (void*pHandle,const char*szRuleName,Sm_PolicyApi_Rule_t**ppstructRule);
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. |
szRuleName
| I | Unique name that corresponds to a global rule. |
ppstructRule
| 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_Rule_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 a scheme.
- Sm_PolicyApi_NotFound. The global rule name was not found.