UnicodeFile Property
The UnicodeFile property specifies or returns a value indicating whether the data read from or written to files by transformations is translated from or to Unicode.
Applies To
| DataPumpTransformReadFile Object | DataPumpTransformWriteFile Object |
Syntax
transerver.UnicodeFile [= boolean]
| Part | Description |
|---|---|
| transerver | Expression that evaluates to an object from the Applies To list. |
| boolean | If TRUE, the file data is translated from or to Unicode. Default is FALSE. |
Data Type
Boolean
Modifiable
Read/write
Prototype (C/C++)
HRESULT UnicodeFile(VARIANT_BOOL* pRetVal);
HRESULT UnicodeFile(VARIANT_BOOL pRetVal);
Remarks
For the DataPumpTransformReadFile object, the file is translated from Unicode to ANSI if the destination column is not Unicode and the UnicodeFile property is TRUE.
For the DataPumpTransformWriteFile object, the source column data has already been translated to from ANSI to Unicode, if necessary. If the UnicodeFile property is TRUE, the Unicode header bytes 0xFFFE are written to the file, unless the AppendIfFileExists property is TRUE and the header is already in the file.
If the UnicodeFile property is TRUE, the OEMFile property is ignored.
The property also can be referenced through the TransformServerProperties collection with the following code:
Set transprops = transform.TransformServerProperties
transprops("UnicodeFile") [= boolean]