bcp_readfmt

适用于:SQL Server Azure SQL 数据库 Azure SQL 托管实例 Azure Synapse Analytics Analytics 平台系统(PDW)

从指定的格式文件中读取数据文件格式定义。

语法

  
RETCODE bcp_readfmt (  
        HDBC hdbc,  
        LPCTSTR szFormatFile);  

参数

hdbc
已启用大容量复制的 ODBC 连接句柄。

szFormatFile
包含数据文件的格式值的文件的路径和文件名。

返回

SUCCEED 或 FAIL。

注解

bcp_readfmt读取格式值后,它会对bcp_columnsbcp_colfmt进行适当的调用。 您无需分析格式文件和进行这些调用。

若要保留格式化文件,请调用 bcp_writefmt。 对 bcp_readfmt 的调用可以引用保存的格式。 有关详细信息,请参阅 bcp_init

或者,大容量复制实用工具(bcp)可以将用户定义的数据格式保存在可由bcp_readfmt引用的文件中。 有关 bcp 实用工具和 bcp 数据格式化文件结构的详细信息,请参阅大容量导入和导出数据(SQL Server)。

bcp_control eOption 参数的 BCPDELAYREADFMT 值修改bcp_readfmt的行为。

注意

格式化文件必须由 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.  

另请参阅

大容量复制函数