Arbortext Command Language > Repository API > oid_encl_poid
  
oid_encl_poid
oid_encl_poid (oid[, obj[, pos]])
Returns the POID that encloses the element specified by oid and pos (if any). If oid is invalid, or the specified oid is not within a POID, the function returns a null string. If the operation is successful, the function returns the POID enclosing the specified oid.
A POID can have two document objects when the POID is a reference to a file entity. The POID will always have a document object handle for the contents of the file entity being referenced. If the reference POID itself is a top-level sibling in another object, it will also have a document object handle for that 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 parent object oid. This means that if the parent oid has both types of object attached, then the file entity object is returned if obj is omitted or 0.
pos can be any of the following values:
0 — (The default.) pos is immediately after the start tag identified by oid.
-1pos is immediately before the end tag of the element identified by oid.
-2pos is immediately before the start tag.
-3 — If oid is a start tag, pos is immediately after the end tag. Otherwise, pos is at the end of the object.