bcp_writefmt

適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

現在の一括コピー データ ファイルの形式に関する記述を含むフォーマット ファイルを作成します。

構文

  
RETCODE bcp_writefmt (  
        HDBC hdbc,  
        LPCTSTR szFormatFile);  

引数

hdbc
一括コピーが有効な ODBC 接続ハンドルです。

szFormatFile
データ ファイルの形式の値を受け取るユーザー ファイルのパスとファイル名です。

戻り値

SUCCEED または FAIL。

解説

フォーマット ファイルでは、一括コピーで作成されるデータ ファイルのデータの形式を指定します。 bcp_columns を呼び出し、データ ファイルの形式を定義bcp_colfmt。 bcp_writefmt は 、この定義を szFormatFile によって参照されるファイルに保存します。 詳細については、「 bcp_init」を参照してください。

bcp データ形式ファイルの構造の詳細については、「bcp ユーティリティを使用した一括データのインポートとエクスポート (SQL Server)」を参照してください。

保存したフォーマット ファイルを読み込むには、bcp_readfmtを使用 します。

Note

bcp_writefmtによって生成されるフォーマット ファイルは、SQL Server バージョン 7.0 以降で配布される bcp ユーティリティのバージョンでのみサポートされます。

例

// Variables like henv not specified.  
HDBC      hdbc;  
DBINT      nRowsProcessed;  
  
// Application initiation, get an ODBC environment handle, allocate the  
// hdbc, and so on.  
...   
  
// Enable bulk copy prior to connecting on allocated hdbc.  
SQLSetConnectAttr(hdbc, SQL_COPT_SS_BCP, (SQLPOINTER) SQL_BCP_ON,  
   SQL_IS_INTEGER);  
  
// Connect to the data source, return on error.  
if (!SQL_SUCCEEDED(SQLConnect(hdbc, _T("myDSN"), SQL_NTS,  
   _T("myUser"), SQL_NTS, _T("myPwd"), SQL_NTS)))  
   {  
   // Raise error and return.  
   return;  
   }  
  
// Initialize bulk copy.   
if (bcp_init(hdbc, _T("myTable"), _T("myData.csv"),  
   _T("myErrors"),    DB_OUT) == FAIL)  
   {  
   // Raise error and return.  
   return;  
   }  
  
if (bcp_columns(hdbc, 3) == FAIL)  
   {  
   // Raise error and return.  
   return;  
   }  
  
bcp_colfmt(hdbc, 1, SQLCHARACTER, 0, SQL_VARLEN_DATA, '\t', 1, 1);  
bcp_colfmt(hdbc, 2, SQLCHARACTER, 0, SQL_VARLEN_DATA, '\t', 1, 2);  
bcp_colfmt(hdbc, 3, SQLCHARACTER, 0, SQL_VARLEN_DATA, '\t', 1, 3);  
  
if (bcp_writefmt(hdbc, _T("myFmtFile.fmt")) == FAIL)  
   {  
   // Raise error and return.  
   return;  
   }  
  
if (bcp_exec(hdbc, &nRowsProcessed) == SUCCEED)  
   {  
   printf_s("%ld rows copied from SQL Server\n", nRowsProcessed);  
   }  
  
// Carry on.  

参照

一括コピー関数