Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

CopyOptions

Synopsis

struct CopyOptions {
    string*     encoding;
    string*     suffix;
    boolean*    overwrite;
    boolean*    cut;
    boolean omitPriceData
}

Options to be used in copy (§copy) operation.

encoding

This attribute specifies the encoding to be used for the OBX stream. The default value of this option is UTF-8.

suffix

This attribute specifies the suffix to be used in case the uri parameter is empty. If the suffix is not empty and does not start with a period character (‘.’), a period is prepended to the suffix. The default value of this option is .obx.

overwrite

This attribute specifies whether the operation should fail if the file specified by the uri parameter already exists (overwrite=false) or overwrite the file. The default value of this option is false.

cut

This attribute

The cut option specifies whether or not the copied items are to be deleted once the OBX stream has been successfully written. The default value of this option is false.

omitPriceData

Possible values are true and false, with false being the default value.