The <apiArray> element specifies any type parts, classifier or data within an interface where required.
You can nest the <apiArray> element for multidimensional arrays. The <apiArray> element has the following attributes: name="arraysize" and value="n", where "n" is the length of the array encapsulated in the object.
The following examples show how the <apiArray value="n"/> element is used for a Visual Basic method:
<apiOperation id="rational.xde"> <apiName>getIntArray</apiName> <shortdesc>Retrieve the contents of the SQL array designated by the object.</shortdesc> <apiOperationDetail> <apiOperationDef> <apiReturn> <apiType name="type" value="int"/> <apiArray value="2"/> </apiReturn> <apiQualifier name="access" value="public"/> </apiOperationDef> </apiOperationDetail </apiOperation>
The following are examples of the <apiArray value="n"/> element use for a Visual Basic parameter:
<apiOperation id="rational.xde"> <apiName></apiName> <shortdesc></shortdesc> <apiOperationDetail> <apiOperationDef> <apiParam> <apiType name="type" value="int"/> <apiArray value="1"/> <apiItemName>num</apiItemName> </apiParam> <apiParam> <apiType name="type" value="string"/> <apiItemName>map</apiItemName> <apiDefItem>contains mapping of SQL type names</apiDefItem> </apiParam> </apiOperationDef> </apiOperationDetail </apiOperation>