|
burstDocument(doc [, name [, folderLogicalId [, flags [, logFile]]]] )
|
|
|
Parameters
|
Documentdoc
Specifies the document to burst. The document must be a file system object.
Stringname
[optional] Specifies the name to use for the topmost object. If the value of this parameter is null or empty, then the bursting rules are consulted.
The adapter is allowed to use a variant of this name if, for example, the CMS disallows two objects with the same name in the same folder. The actual name used can be obtained by accessing the CMSObject attribute on the ADocument after a successful burst and then accessing that object's name attribute.
StringfolderLogicalId
[optional] Specifies the destination folder for all objects created. If the value of this parameter is null or empty, then the bursting rules are consulted. This may be the Logical ID of a folder or it may be in an adapter-specific path format.
If your system-wide bursting configuration specification has the useroverride setting set to on, then the folder parameter provides a user-specified destination folder for all objects created. If the value of this parameter is null or empty, then the bursting rules determine in which folders the new objects are created.
If your system-wide bursting configuration specification has the useroverride setting set to off, then the folder parameter is not used and the bursting rules determine in which folders the new objects are created.
See the burstUserOverride attribute for more details.
intflags
[optional] Specifies the flags which control the bursting behavior. The value is a bit-wise OR of the CMSSessBurstFlags constants. The negative flag settings override session defaults.
StringlogFile
[optional] Specifies the full path of a local log file to which this method will append diagnostic information related to bursting this document.
|
|
Returns
|
void. The given document is now associated with a new top-level object in the CMS. The CMSObject attribute of the ADocument interface can be used to access information about the new top-level object.
|
|
Throws
|
CMSException
Raised for any error bursting the document.
|