Retrieves an override rule identified by its guid or name.

        GSErrCode  ACAPI_Override_GetOverrideRule (
            API_OverrideRule&      rule
        );
    

 

Parameters

rule

[in] The guid field specifies the rule to retrieve. If the guid field is APINULLGuid, then the name field is used to find the rule.

[out] The retrieved rule.

 

Return Values

NoError

The function has completed with success.

APIERR_BADID

The guid or name did not refer to a valid override rule.

For other common API errors see the API Errors document.

 

Example

GSErrCode GetOverrideRuleNames (GS::Array<GS::UniString>& ruleNames)
{
    GS::Array<API_Guid> rulesGuids;
    GSErrCode error = ACAPI_Override_GetOverrideRuleList (rulesGuids);
    if (error == NoError) {
        for (USize i = 0; i < rulesGuids.GetSize(); ++i) {
            API_OverrideRule rule = {rulesGuids[i]};
            error = ACAPI_Override_GetOverrideRule (rule);
            if (error == NoError) {
                ruleNames.Push (rule.name);
            }
        }
    }

    return error;
}

For more detailed examples, please see the Override_Test add-on.

 

Requirements

Version: API 20 or later

Header: ACAPinc.h

 

See Also

Visual Override,
API Functions