apiData

The <apiData> element specifies the actual value such as the initial value of variable, the default value of a parameter, or the value of a constant.

Description

This element provides a literal value such as "5 Maple Street" or "6" typically where a parameter or variable has a default or initial value.

For example, if the description of the data type is not available, you must provide the name of the related API item inside the <apiData> element and the fully qualified name of the element in the keyref attribute. The keyref attribute should provide a unique key such as a fully qualified classifier name for the named API item.

Example

The following example shows a simple <apiData> element for a Visual Basic property:

<apiValue>
       <apiValueDetail>
           <apiValueDef>
              <apiType value="month"/>
              <apiData>25</apiData>
              <apiDefNote>
                   Returns the day and month that the element belongs to.
              </apiDefNote>
           </apiValueDef>
       </apiValueDetail>
   </apiValue>

Contained by

apiClassifierDef, apiClassifierMember, apiConstructorDef, apiDef, apiDefItem, apiEvent, apiOperationDef, apiOperationDefItem, apiParam, apiReturn, apiSyntaxText, apiValueDef, apiValueMember

Contains

apiname, b, boolean, cite, cmdname, codeph, draft-comment, filepath, fn, i, image, indexterm, indextermref, keyword, menucascade, msgnum, msgph, option, parmname, ph, q, required-cleanup, state, sub, sup, synph, systemoutput, term, tm, tt, u, uicontrol, userinput, varname, wintitle, xref

Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or image or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Inheritance

topic/ph reference/ph