cxxDefine

The <cxxDefine> element provides the name of the C++ API define, all the elements necessary to describe the members that are introduced by the define declaration.

Description

The <cxxDefine> element requires an id attribute as an anchor point; this id must always be specified. The id attribute is referenced by the conref attribute and internal applications that refer to the <cxxDefine> element content. The elements <apiName> and <cxxDefineDetail> are required for this top-level container.

Example

<cxxFile id="cfperfmetrics_8cpp">
	<apiName>cfperfmetrics.cpp</apiName>
	<cxxDefine id="cfperfmetrics_8cpp_1aaf45a4d8cdebb244b0f01672cd981fb2">
		<apiName>SYMBIAN_ENABLE_NETWORKING_PERFMETRICS</apiName>
		<cxxDefineDetail>
			<cxxDefineDefinition>
				<cxxDefineAccessSpecifier value="public"/>
				<cxxDefinePrototype>#define SYMBIAN_ENABLE_NETWORKING_PERFMETRICS</cxxDefinePrototype>
				<cxxDefineNameLookup>SYMBIAN_ENABLE_NETWORKING_PERFMETRICS</cxxDefineNameLookup>
				<cxxDefineParameters/>
				<cxxDefineAPIItemLocation>
					<cxxDefineDeclarationFile name="filePath" value="C:/EPOC/master/sf/os/commsfw/commsfwsupport/commselements/commsfw/src/cfperfmetrics.cpp"/>
					<cxxDefineDeclarationFileLine name="lineNumber" value="17"/>
				</cxxDefineAPIItemLocation>
			</cxxDefineDefinition>
			<apiDesc/>
		</cxxDefineDetail>
	</cxxDefine>
	<cxxVariable id="cfperfmetrics_8cpp_1a8b57c8f405cbc5de5ad9caf2e1610d0f">
		...
	</cxxVariable>
	<cxxEnumeration id="cfperfmetrics_8cpp_1a3a00212a28f7e4e2af6d5d57db53f4d3">
		...
	</cxxEnumeration>
	<cxxFileAPIItemLocation>
		<cxxFileDeclarationFile name="filePath" value="C:/EPOC/master/sf/os/commsfw/commsfwsupport/commselements/commsfw/src/cfperfmetrics.cpp"/>
	</cxxFileAPIItemLocation>
</cxxFile>

Contained by

cxxUnion cxxClass cxxStruct

Contains

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

Content Model

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

Inheritance

topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation cxxDefine/cxxDefine