apiReturn

The <apiReturn> element can return a typed value such as an integer or object classifier.

Description

In the <apiReturn> element, the <state>, <keyword>, and <ph> elements are provided to support unexpected contingencies within the value to return.

Example

The following example shows an <apiReturn> element for a Visual Basic method.

<apiOperation id="com.ibm.xtools.rational.xde">
   <apiName>getApplicableStereotypesAsString</apiName>
   <apiOperationDef>
       <apiReturn>
          <apiOperationClassifier href=”String.dita”>String</apiOperationClassifier>
          <apiDefNote>
              Returns a string that specifies the stereotypes that can be associated
              with the extensible element.
          </apiDefNote>
       </apiOperationDef>
      <apiReturn>
   </apiOperationDetail>
</apiOperation>

Contained by

apiOperationDef

Contains

apiArray, apiData, apiDefNote, apiItemName, apiname, apiOperationClassifier, apiOperationDefItem, apiQualifier, apiRelation, apiType, b, cmdname, codeph, filepath, i, keyword, menucascade, msgnum, msgph, option, parmname, ph, state, sub, sup, synph, systemoutput, tt, u, uicontrol, userinput, varname, wintitle

Content model

(apiItemName or apiOperationClassifier or apiQualifier or apiRelation or apiType or apiArray or apiData or apiDefNote or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle 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 apiOperationDefItem) (any number)

Inheritance

topic/ph reference/ph apiRef/apiDefItem