ACAPI_​Element_​GetClassificationInSystemDefault

Retrieves a classification of a default elem in a given classification system.

    GSErrCode  ACAPI_Element_GetClassificationInSystemDefault (
        API_ElemTypeID              typeID,
        API_ElemVariationID         variationID,
        const API_Guid&             systemGuid,
        API_ClassificationItem&     item
    );

 

Parameters

typeID
[in] Type of the default element.
variationID
[in] The element variation that distinguishes the element kinds of the same type.
systemGuid
[in] The guid of the classification system in which the classification item should be retrieved.
item
[out] The retrieved classification item (empty with null guid if the elem doesn’t have a classification in the given system).

 

Return Values

NoError
The function has completed with success.
APIERR_BADID
The typeID and variationID together did not refer to a valid default element or systemGuid did not refer to a valid classification system.

For other common API errors see the API Errors document.

 

Example

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

 

Requirements

Version: API 21 or later
Header: ACAPinc.h

 

See Also

Classification,
API Functions