Returns the array of renovation filters.

    GSErrCode ACAPI_Database (
        APIDb_GetRenovationFiltersID,
        GS::Array<API_Guid>*         renovationFilterList
    );

 

Parameters

renovationFilterList

[out] The array of renovation filters.

 

Return Values

NoError

The function has completed with success.

APIERR_BADPARS

The renovationFilterList parameter is nullptr.

For other common API errors see the API Errors document.

 

Remarks

This function returns the renovation filters as an array of Guids. To get the current renovation filter use the APIDb_GetActualRenovationFilterID function.

The name of the renovation filter can be retrieved with the APIAny_GetRenovationFilterNameID function.

 

Example

GS::Array<API_Guid> renFilters;
err = ACAPI_Database (APIDb_GetRenovationFiltersID, &renFilters);
if (err == NoError) {
    GS::USize nRenFilters = renFilters.GetSize ();
    for (GS::UIndex i = 0; i < nRenFilters; ++i) {
        if (oldView.renovationFilterGuid == renFilters[i]) {
            newView.renovationFilterGuid = renFilters[i + 1 >= nRenFilters ? 0 : i + 1];
            break;
        }
    }
}

Further renovation filter and navigator view code samples can be found in the Environment_Control and Navigator_Test example add-ons.

 

Requirements

Version: API 18 or later

Header: APIdefs_Database.h

 

See Also

ACAPI_Database, APIDb_GetActualRenovationFilterID, APIAny_GetRenovationFilterNameID
API Functions