cxxVariable

The <cxxVariable> element contains the elements necessary to describe a variable.

Description

The <cxxVariable> element requires the id attribute so that it can be referenced by other topics. <cxxVariable> also requires an <apiname> element to specify the variable name, the the <cxxVariableDetail> element to hold the variable description.

Example

<cxxClass id="a_class">
    <apiName>AClass</apiName>
    <cxxClassDetail>
        ...
    </cxxClassDetail>
    <cxxFunction id="a_class_1a0cd89cbef4c7224dab024bfa3182b99e">
        ...
    </cxxFunction>
    <cxxVariable id="a_class_1ae0375">
        <apiName>iFunctions</apiName>
        <cxxVariableDetail>
            <cxxVariableDefinition>
                <cxxVariableAccessSpecifier value="protected"/>
                <cxxVariableDeclaredType>
                    <apiRelation href="a_class_general_functions.xml#class_m_anim_general_functions">MAnimGeneralFunctions</apiRelation> *</cxxVariableDeclaredType>
                <cxxVariableScopedName>CAnim</cxxVariableScopedName>
                <cxxVariablePrototype>MAnimGeneralFunctions * iFunctions</cxxVariablePrototype>
                <cxxVariableNameLookup>CAnim::iFunctions</cxxVariableNameLookup>
                <cxxVariableAPIItemLocation>
                    <cxxVariableDeclarationFile name="filePath" value="C:/src/include/w32adll.h"/>
                    <cxxVariableDeclarationFileLine name="lineNumber" value="908"/>
                </cxxVariableAPIItemLocation>
            </cxxVariableDefinition>
            <apiDesc>
                <p>Pointer to a class containing functions implemented by the window server.</p>
                <p>These are available to any <xref href="a_class.xml#a_class">CAnim</xref> derived class.</p>
                <p>Note that this value is automatically set for you by the animation framework. You do not need to assign a value to this pointer.</p>
            </apiDesc>
        </cxxVariableDetail>
    </cxxVariable>
    <cxxClassInherits>
        ...
    </cxxClassInherits>
</cxxClass>

Contained by

cxxUnion cxxClass cxxStruct

Contains

apiName, cxxVariableDetail no-topic-nesting, prolog, related-links, shortdesc,

Content Model

(apiName, then shortdesc, then prolog, then cxxVariableDetail then related-links, then (no-topic-nesting, ))

Inheritance

topic/topic reference/reference apiRef/apiRef apiValue/apiValue cxxVariable/cxxVariable