FileColumnName Property

DTS Programming

DTS Programming

FileColumnName Property

The FileColumnName property specifies or returns the name of the source column that contains the name of the file to be written. It must be one of the two source columns of the transformation.

Applies To
DataPumpTransformWriteFile Object
Syntax

object.FileColumnName [= string]

Part Description
object Expression that evaluates to a DataPumpTransformWriteFile object
string Name of the source column that contains the name and optional path of file to be written

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFileColumnName(BSTR* pRetVal);

HRESULT SetFileColumnName(BSTR pRetVal);

Remarks

The FileColumnName must be a string data type. It cannot be NULL or empty, and the data column to which it refers cannot be NULL or empty. If the file name column contains a path, it can use either a drive letter or a universal naming convention (UNC) name.

If no path is present, the FilePath property can be used to supply the path. However, FilePath is always used when it is contains a value, even when the file name column contains a path.

The property also can be referenced through the TransformServerProperties collection with the following code:

Set transprops = transform.TransformServerProperties
transprops("FileColumnName") [= string]

See Also

FilePath Property