Retrieves a list of all override rules in the current plan.
GSErrCode ACAPI_Override_GetOverrideRuleList ( GS::Array<API_Guid>& ruleList );
Parameters
- ruleList
- [out] The list of all override rules in the current plan.
Return Values
NoError
- The function has completed with success.
For other common API errors see the API Errors document.
Example
For more detailed examples, please see the Override_Test add-on.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; }
Requirements
- Version: API 20 or later
- Header: ACAPinc.h