IBCPSession::BCPInit (Native Client OLE DB Provider)
Applies to: 
SQL Server
Azure SQL Database
Azure SQL Managed Instance
Azure Synapse Analytics
Analytics Platform System (PDW)
Important
The SQL Server Native Client (often abbreviated SNAC) has been removed from SQL Server 2022 (16.x) and SQL Server Management Studio 19 (SSMS). Both the SQL Server Native Client OLE DB provider (SQLNCLI or SQLNCLI11) and the legacy Microsoft OLE DB Provider for SQL Server (SQLOLEDB) are not recommended for new development. Switch to the new Microsoft OLE DB Driver (MSOLEDBSQL) for SQL Server going forward.
Initializes the bulk copy structure, performs some error checking, verifies that the data and format file names are correct, and then opens them.
Syntax
HRESULT BCPInit(
const wchar_t *pwszTable,
const wchar_t *pwszDataFile,
const wchar_t *pwszErrorFile,
int eDirection);
Remarks
The BCPInit method should be called before any other bulk-copy method. The BCPInit method performs the necessary initializations for a bulk copy of data between the workstation and SQL Server.
The BCPInit method examines the structure of the database source or target table, not the data file. It specifies data format values for the data file based on each column in the database table, view, or SELECT result set. This specification includes the data type of each column, the presence or absence of a length or null indicator and terminator byte strings in the data, and the width of fixed-length data types. The BCPInit method sets these values as follows:
The data type specified is the data type of the column in the database table, view, or SELECT result set. The data type is enumerated by SQL Server native data types specified in the SQL Server Native Client header file (sqlncli.h). Their values are in the pattern of BCP_TYPE_XXX. The data is represented in its computer form. That is, data from a column of integer data type is represented by a four-byte sequence that is big-or little-endian based on the computer that created the data file.
If a database data type is fixed in length, the data file data is also fixed in length. Bulk-copy methods that process data (for example, IBCPSession::BCPExec) parse data rows expecting the length of the data in the data file to be identical to the length of the data specified in the database table, view, or SELECT column list. For example, data for a database column defined as
char(13)must be represented by 13 characters for each row of data in the file. Fixed-length data can be prefixed with a null indicator if the database column allows null values.When copying data to SQL Server, the data file must have data for each column in the database table. When copying data from SQL Server, data from all columns in the database table, view, or SELECT result set are copied to the data file.
When copying data to SQL Server, the ordinal position of a column in the data file must be identical to the ordinal position of the column in the database table. When copying data from SQL Server, the BCPExec method places data based on the ordinal position of the column in the database table.
If a database data type is variable in length (for example,
varbinary(22)) or if a database column can contain null values, data in the data file is prefixed by a length/null indicator. The width of the indicator varies based on the data type and version of bulk copy. The IBCPSession::BCPControl method option BCP_OPTION_FILEFMT provides compatibility between earlier bulk-copy data files and servers running later versions of SQL Server by indicating when the width of indicators in the data is narrower than expected.
Note
To change the data format values specified for a data file, use the IBCPSession::BCPColumns and IBCPSession::BCPColFmt methods.
Bulk copies to SQL Server can be optimized for tables that do not contain indexes by setting the database option select into/bulkcopy.
Arguments
pwszTable[in]
The name of the database table to be copied into or out of. The name can include the database name or the owner name. For example, "pubs.username.titles", "pubs..titles", "username.titles".
If the eDirection argument is set to BCP_DIRECTION_OUT, the pwszTable argument can be the name of a database view.
If the eDirection argument is set to BCP_DIRECTION_OUT and a SELECT statement is specified using the BCPControl method before the BCPExec method is called, the pwszTable argument must be set to NULL.
pwszDataFile[in]
The name of the user file to be copied into or out of.
pwszErrorFile[in]
The name of the error file to be filled with progress messages, error messages, and copies of any rows that could not be copied from a user file to a table. If the pwszErrorFile argument is set to NULL, no error file is used.
eDirection[in]
The direction of the copy operation, either BCP_DIRECTION_IN or BCP_DIRECTION _OUT. BCP_DIRECTION _IN indicates a copy from a user file to a database table; BCP_DIRECTION _OUT indicates a copy from a database table to a user 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_INVALIDARG
One or more of the arguments was not correctly specified. For example, an invalid file name was given.