Arbortext Command Language > Repository API > oid_dobj
  
oid_dobj
oid_dobj (oid[, obj])
Returns the document object handle for the element specified by oid (if any). If oid is invalid, or the specified oid has no document object handle, the function returns a zero (0). If the operation is successful, the function returns the document object handle for the oid. The dobj_close function must be called to close the document object after it has been processed.
A document can have two types of objects: file entity references and other objects. oids representing file entity references may have 2 objects associated with them: one object and one file entity reference object.
If obj is 1, then file entity objects will not be returned. If it is omitted or 0, then a file entity object will be returned if there is one on the oid. This means that if the oid has both types of object attached, then the file entity object is returned if obj is omitted or 0.
An XInclude oid can also have multiple objects attached. This method returns the innermost object on the oid if it is an XML inclusion. If you do not want the innermost object, use the dobj_encl_dobj function.
If oid is not a file entity reference, obj is ignored.