dms.GetObjDef

This job returns all object definitions in XML format.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Options for this job Visibility is checked independently of the object flag 'ignore security system'.
1 = Object definition is returned via parameter sRet, otherwise as XML file
2 = Visible cabinets and objects are output, but no field information. The
4 = Images of the object definition are output encoded in BASE64 in the XML return.
4096 = the XML document is encoded in UTF-8, otherwise UTF-16

2. Output Parameters

Name Type Dependency Description

[sRet]

BASE64

Optional

Object definition in XML format

3. Output Files

Name Description

[FileCount]

1 = Output file was successfully created, otherwise 0

[FileList]

Name and path of the XML file containing the object definition

4. Return Value

(INT): 0 = Job successful, otherwise error code
Complete list of error codes

Object definitions in XML format
<?xml version="1.0" encoding="UTF-8"?>
<asobjdef version="4.00">
  <OS4x/>
  <languages>
    <language/>
  </languages>
  <cabinet>
    <object kisearchindex="1" no_dias="0" referencetype="0" fulltext="0" apply_security="0" multidoc="0">
      <names>
        <name/>
      </names>
      <fields>
        <field>
          <names>
            <name/>
          </names>
          <ids/>
          <flags align="left" dt="A" input_length="0" readonly="supervisor" multifield="0" zeropad="0" control_type="edit" datatype="text" constraints="none" required="0" crosscheck="0" case="0"/>
          <field_pos bottom="0" left="0" right="0" top="0"/>
          <input_pos bottom="0" left="0" right="0" top="0"/>
          <init func="0" init_type="const"/>
          <list multiselection="0" order="0">
            <rawdata/>
            <extra/>
            <row/>
          </list>
          <page/>
        </field>
      </fields>
      <ids/>
      <frame bottom="0" left="0" right="0" top="0"/>
      <multiframe/>
    </object>
  </cabinet>
</asobjdef>