cxxStruct

The <cxxStruct> element provides the name of the C++ API struct, all the elements necessary to describe the members that are introduced by the struct declaration, and the members inherited from the direct base struct.

Description

The <cxxStruct> 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 <cxxStruct> element content. The elements <apiName> and <cxxStructDetail> are required for this top-level container.

Example

<cxxClass id="GUID-697DBFB2-9EB6-3C22-BB12-92FDF3A03DF4">
	<apiName>CSocketServer</apiName>
	<cxxClassDetail>
		<cxxClassDefinition>
			<cxxClassAccessSpecifier value="public" />
			<cxxClassAPIItemLocation>
				<cxxClassDeclarationFile name="filePath" value="s:/sf/os/commsfw/datacommsserver/esockserver/inc/ss_std.h" />
				<cxxClassDeclarationFileLine name="lineNumber" value="309" />
			</cxxClassAPIItemLocation>
		</cxxClassDefinition>
		<apiDesc />
	</cxxClassDetail>
</cxxClass>
            

Contained by

Contains

apiName, cxxDefine cxxEnumeration cxxFunction cxxStructDetail cxxStructInherits cxxStructNested cxxTypedef cxxVariable prolog, related-links, shortdesc,

Content Model

(apiName, then shortdesc, then prolog, then cxxStructDetail then related-links, then ((cxxStructNested or cxxFunction or cxxDefine or cxxVariable or cxxEnumeration or cxxTypedef (any number) ) ) then cxxStructInherits (any number) )

Inheritance

topic/topic reference/reference apiRef/apiRef apiClassifier/apiClassifier cxxStruct/cxxStruct