Description: The <apiSyntax> element provides the representation in the programming language for the declared interface for the API item.

# apiSyntax

The <apiSyntax> element provides the representation in the programming language for the declared interface for the API item.

#### Description

In the <apiDef> element, the <apiSyntax> element can supplement or replace the semantic declaration of the same interface. When a specialization provides a complete representation of the interface within a specialized <apiDef> element, it can omit the <apiSyntax> element. The Java API reference takes this approach.

#### Example

The following example shows an <apiValueClassifier> element for a Visual Basic property:

    <apiOperation id="IRXEAbstarction">

    <apiClassifieer id="IRXEAbstarction.Model">
          <apiName>Model</apiName>
          <shortDesc>Retrieves the IRXEModel object that the element belongs to.</shortDesc>
          <apiDesc>
              <note>You must have an open read action before calling this property.
                 For more information, see  Understanding Actions.
              </note>
           </apiDesc>
    </apiClassifier>

    </apiOperation>

#### Contained by

apiClassifierDetail, apiDetail, apiOperationDetail, apiValueDetail

#### Contains

apiSyntaxItem, apiSyntaxText

#### Content model

( (apiSyntaxText) (one or more) then (apiSyntaxItem) (any number))

#### Inheritance

topic/section reference/refsyn

- apiSyntaxText
  The <apiSyntaxText> element provides the representation in the programming language for the declared interface for the API item.
- apiSyntaxItem
  The <apiSyntaxItem> element provides the programming language representation of the declared interface for the API item.

Parent topic: apiValueDetail