Description: Defines a top-level container for general-purpose topic types for a function, method, subroutine, procedure, event handler, or other named unit of executable code.

# apiOperation module

Defines a top-level container for general-purpose topic types for a function, method, subroutine, procedure, event handler, or other named unit of executable code.

#### Description

In an apiOperation topic type you can create a New Document Type by clicking File > New from the Epic Editor Menu. An <apiOperation> element is a single callable behavior. Examples include Java methods, Perl subroutines, C functions, and so on.

#### Example

The following example shows an <apiOperation> element used for a Visual Basic method:

    <apiOperation id="RXEApplication" outputclass="Method">
       <apiName>startWriteAction</apiName>
       <shortdesc>Opens a write action.</shortdesc>
       <apiOperationDetail>
          <apiOperationDef>
            <apiSyntax>
             <apiSyntaxText>Public Sub startWriteAction( <┘
                           theNameOPT As String <┘
                   ) <┘
              </apiSyntaxText>
            <apiSyntax>
          </apiOperationDef>
          <apiDesc>All model element manipulations must be performed.</apiDesc>
          <section>
             <note>You must have an open write action before calling this method.
                 For more information, see <xref href=""> Understanding Actions</xref>.
             </note>
           </section>
           <example>An example of the method.</example>
         </apiOperationDetail>
    </apiOperation>

- apiOperation
  The <apiOperation> element specifies a collection of features, such as attributes, methods, values, and operations.

Parent topic: apiPackage
Parent topic: apiClassifier
Parent topic: Generic API topic types
Parent topic: apiValue