Tells whether a classification item is visible for an element.

    bool  ACAPI_Element_IsClassificationItemVisible (
        const API_Guid&     elemGuid,
        const API_Guid&     classificationGuid
    );

 

Parameters

elemGuid

[in] The element GUID to search for.

classificationGuid

[in] The classification item GUID to search for.

 

Return Values

true

The given classification item is visible for the element. It can return true even if the parent of the classification item is hidden.

false

The given classification item is not visible for the element or invalid parameters.

Example

GSErrCode GetVisibleClassificationItems (const API_Guid& elemGuid, GS::Array<API_ClassificationItem>& visibleClassifications)
{
    GS::Array<API_ClassificationItem> definitions;
    GSErrCode error = ACAPI_Classification_GetClassificationItems (APINULLGuid, definitions);
    if (error == NoError) {
        for (UInt32 i = 0; i < definitions.GetSize (); ++i) {
            if (ACAPI_Element_IsClassificationItemVisible (elemGuid, definitions[i].guid)) {
                visibleClassifications.Push (definitions[i]);
            }
        }
    }
    return error;
}
        

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

 

Requirements

Version: API 21 or later

Header: ACAPinc.h

 

See Also

Classifications, Classification and Property Visibility