sess_doc_burst
sess_doc_burst (sesshdl[, doc[, flags[, name[, folder[, fid]]]]])
Bursts the specified document into an established repository session. The document must be a file system object. The sesshdl parameter is the currently active session handle. The doc specifies the document to burst. If zero (0), the current document is used. The flags parameter specifies any desired overrides to default bursting options and is published by ORing the following bits:
• 0x0001 — Enable full text indexing on the top most object.
• 0x0002 — Import file entities.
• 0x0004 — Do not import file entities.
• 0x0008 — Import graphic files.
• 0x0010 — Do not import graphic files.
• 0x0020 — Burst on element boundaries.
• 0x0040 — Ignore element boundaries.
• 0x0080 — Use the file name for the topmost object name.
• 0x0100 — Do not use the file name for the topmost object name.
• 0x0400 — Lock the topmost object for editing.
• 0x0800 — Do not lock the topmost object.
• 0x1000 — Use location rules for child objects even when useroverride="on" in the burst configuration file.
The negative flag settings override session defaults.
The name parameter gives a user-specified name to use for the topmost object. If the value is a null string, then the bursting rules are consulted.
The folder parameter gives a user-specified destination folder for all objects created. If your system-wide bursting configuration specification has the useroverride set to on, then the folder parameter gives a user-specified destination folder for all objects created. If a null string, then the bursting rules determine in which folders the new objects are created. If your system-wide bursting configuration specification has the useroverride set to off, then the folder parameter is not used and the bursting rules determine in which folders the new objects are created.
The fileid is an ACL file handle as returned by open() to use for logging information and error messages. If fileid is greater than or equal to zero (0), then no logging is performed.
If the dobj contains sibling (that is, more than one) top-level elements, it will not be burst. If dobj is invalid, or the burst fails, the function sets $main::ioerr with error information and returns a zero (0). If the burst is successful, the function returns a one (1).
Related Topics