FormatFilePath Property
The FormatFilePath property exposes the path and file name of a bulk-copy format file.
Applies To
| BulkCopy Object |
Syntax
object.FormatFilePath [= value]
Part
object
Expression that evaluates to an object in the Applies To list
value
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-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 BulkCopy object. The property has meaning only when the DataFileType property is SQLDMODataFile_UseFormatFile.
For more information about SQL Server bulk copy format files, see Using Format Files.