ibcpsession-bcpwritefmt-ole-db.md

title	description	author	ms.author	ms.date	ms.service	ms.subservice	ms.topic	helpviewer_keywords	apiname	apitype
IBCPSession::BCPWriteFmt (Native Client OLE DB provider)	IBCPSession::BCPWriteFmt (Native Client OLE DB provider)	markingmyname	maghan	03/06/2017	sql	native-client	reference	BCPWriteFmt method	IBCPSession::BCPWriteFmt (OLE DB)	COM

IBCPSession::BCPWriteFmt (Native Client OLE DB Provider)

[!INCLUDESQL Server Azure SQL Database Synapse Analytics PDW]

Important

[!INCLUDEsnac-removed-oledb-only]

Writes format information for each column to the format file.

Syntax

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);  

Remarks

The format file specifies the data format of a data file created by bulk copy. Calls to the IBCPSession::BCPColumns and IBCPSession::BCPColFmt methods define the format of the data file. The BCPWriteFmt method saves this definition in the file referenced by the pwszFormatFile argument.

The BCPWriteFmt method can save the format files in either xml or text format. This must be indicated by using the BCP_OPTION_XML control option with the IBCPSession::BCPControl method.

To load a saved format file, use the IBCPSession::BCPReadFmt method.

Arguments

pwszFormatFile[in]
The path and file name of the file containing the format values for the data file.

Return Code Values

S_OK
The method succeeded.

E_FAIL
A provider-specific error occurred; for detailed information, use the ISQLServerErrorInfo interface.

E_OUTOFMEMORY
Out-of-memory error.

E_UNEXPECTED
The call to the method was unexpected. For example, the IBCPSession::BCPInit method was not called before calling this method.

See Also

IBCPSession (OLE DB)
Performing Bulk Copy Operations