cxxEnumeratorInitialiser

The <cxxEnumeratorInitialiser> element specifies the initial value of the enumerator.

Description

The <cxxEnumeratorInitialiser> element has no child elements but requires the attribute value and can also contain the attribute name. value holds the value that the enumerator has been initialised to. The same value can be seen in the <cxxEnumeratorPrototype> element. The optional attribute name is set to "value" only.

Example

<cxxEnumerator id="class_comms_f_w_1_1_t_c_f_comms_message_1af63a04e824301ca2a579a22575f11b36a6dc8b8c63fbd0f5f99b6dd3955dd03e2">
    <apiName>ECodePrivateFlag</apiName>
    <cxxEnumeratorScopedName>CommsFW::TCFCommsMessage</cxxEnumeratorScopedName>
    <cxxEnumeratorPrototype>ECodePrivateFlag = 128</cxxEnumeratorPrototype>
    <cxxEnumeratorNameLookup>CommsFW::TCFCommsMessage::ECodePrivateFlag</cxxEnumeratorNameLookup>
    <cxxEnumeratorInitialiser value="128"/>
    <cxxEnumeratorAPIItemLocation>
        <cxxEnumeratorDeclarationFile name="filePath" value="C:/src/include/cfmsgs.h"/>
        <cxxEnumeratorDeclarationFileLine name="lineNumber" value="96"/>
    </cxxEnumeratorAPIItemLocation>
    <apiDesc>
        <p>Private message flag; CF channel is being used to convey a message specific to the binding end-points. </p>
    </apiDesc>
</cxxEnumerator>

Contained by

cxxEnumerator

Contains

Content Model

No content.

Inheritance

topic/ph reference/ph apiRef/apiData apiValue/apiData cxxEnumeration/cxxEnumeratorInitialiser