FormatFilePath Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The FormatFilePath property exposes the path and file name of a bulk-copy format file.

Syntax

object
.FormatFilePath [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A string that specifies an operating system file

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFormatFilePath(SQLDMO_LPBSTR pRetVal);
HRESULT SetFormatFilePath(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

Microsoft SQL Server bulk-copy operations can use a user-specified data format stored in a text file. The FormatFilePath indicates a data format file to the BulkCopyobject. The property has meaning only if the DataFileType property is SQLDMODataFile_UseFormatFile.

For more information about SQL Server bulk copy format files, see Using a Format File to Bulk Import Data.

Applies To:

See Also

Reference