bcp_readfmt

適用対象: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

指定されたフォーマット ファイルからデータ ファイル形式の定義を読み取ります。

構文

  
RETCODE bcp_readfmt (  
        HDBC hdbc,  
        LPCTSTR szFormatFile);  

引数

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

szFormatFile
データ ファイルの形式の値を含むファイルに関するパスとファイル名です。

返品

SUCCEED または FAIL。

解説

bcp_readfmt形式の値を読み取ると、bcp_columnsとbcp_colfmtに対して適切な呼び出しが行われます。 ユーザーがフォーマット ファイルを解析し、このような呼び出しを行う必要はありません。

フォーマット ファイルを保持するには、 bcp_writefmtを呼び出します。 bcp_readfmtの呼び出しでは、保存された形式を参照できます。 詳細については、「 bcp_init」を参照してください。

または、一括コピー ユーティリティ (bcp) を使用して、 bcp_readfmtで参照できるファイルにユーザー定義データ形式を保存できます。 bcpユーティリティとbcpデータフォーマットファイルの構造の詳細については、「データのインポートとエクスポート (SQL Server)を参照してください。

bcp_controlの eOption パラメーターの BCPDELAYREADFMT 値は、bcp_readfmtの動作を変更します。

Note

フォーマット ファイルは、 bcp ユーティリティのバージョン 4.2 以降で生成されている必要があります。

例

// 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_IN) == FAIL)  
   {  
   // Raise error and return.  
   return;  
   }  
  
if (bcp_readfmt(hdbc, _T("myFmtFile.fmt")) == FAIL)  
   {  
   // Raise error and return.  
   return;  
   }  
  
if (bcp_exec(hdbc, &nRowsProcessed) == SUCCEED)  
   {  
   cout << nRowsProcessed << " rows copied to SQL Server\n";  
   }  
  
// Carry on.  

参照

一括コピー関数