Deletes an override rule identified by its guid.

        GSErrCode  ACAPI_Override_DeleteOverrideRule (
            const API_Guid&       rule
        );
    

 

Parameters

rule

[in] The guid of the rule to delete.

 

Return Values

NoError

The function has completed with success.

APIERR_BADID

The guid did not refer to a valid override rule.

APIERR_NOACCESSRIGHT

Tried to delete a built-in rule.

For other common API errors see the API Errors document.

 

Example

GSErrCode DeleteAllUserDefinedOverrideRule ()
{
    GS::Array<API_Guid> ruleList;
    GSErrCode err = ACAPI_Override_GetOverrideRuleList (ruleList);
    if (err == NoError) {
        for (USize i = 0; i < ruleList.GetSize(); ++i) {
            ACAPI_Override_DeleteOverrideRule (ruleList[i]);
        }
    }
    
    return err;
}

        

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