IBCPSession2::BCPSetBulkMode

[アーティクル]
05/07/2013

列の形式を指定する場合に、IBCPSession::BCPColFmt (OLE DB) の代わりに IBCPSession2::BCPSetBulkMode を使用できます。個別の列形式属性を設定する IBCPSession::BCPColFmt とは異なり、IBCPSession2::BCPSetBulkMode はすべての属性を設定します。

構文

HRESULT BCPSetBulkMode (
      int property,
   void * pField,
   int cbField,
   void * pRow,
   int cbRow
);

引数

property
BYTE 型の定数です。定数の一覧については、「解説」の表を参照してください。
pField
フィールドターミネータ値を指すポインターです。
cbField
フィールドターミネータ値の長さです (バイト単位)。
pRow
行ターミネータ値を指すポインターです。
cbRow
行ターミネータ値の長さです (バイト単位)。

戻り値

IBCPSession2::BCPSetBulkMode は次のいずれかを返すことができます。

S_OK	メソッドが成功しました。
E_FAIL	プロバイダー固有のエラーが発生しました。エラーの詳細を確認するには、ISQLServerErrorInfo インターフェイスを使用してください。
E_UNEXPECTED	メソッドの呼び出しが予期されませんでした。たとえば、IBCPSession2::BCPSetBulkMode を呼び出す前に、IBCPSession2::BCPInit メソッドが呼び出されなかった場合などです。
E_INVALIDARG	引数が無効です。
E_OUTOFMEMORY	メモリ不足エラーです。

説明

IBCPSession2::BCPSetBulkMode を使用すると、クエリまたはテーブルの一括コピー出力を実行できます。 IBCPSession2::BCPSetBulkMode を使用してクエリステートメントを一括コピー出力する場合は、IBCPSession::BCPControl(BCP_OPTIONS_HINTS, …) を呼び出してクエリステートメントを指定する前に、これを呼び出す必要があります。

RPC 呼び出し構文とバッチクエリ構文 ({rpc func};SELECT * from Tbl など) を 1 つのコマンドテキスト内で組み合わせて使用しないでください。 ICommandPrepare::Prepare によってエラーが返され、メタデータを取得できなくなるためです。ストアドプロシージャの実行とバッチクエリを 1 つのコマンドテキストで組み合わせて使用する必要がある場合は、ODBC CALL 構文 ({call func}; SELECT * from Tbl など) を使用します。

property パラメーターとして使用できる定数の一覧を次の表に示します。

プロパティ	説明
BCP_OUT_CHARACTER_MODE	文字出力モードを指定します。 BCP.EXE の –c オプション、および eUserDataType プロパティを BCP_TYPE_SQLCHARACTER に設定した IBCPSession::BCPColFmt に相当します。
BCP_OUT_WIDE_CHARACTER_MODE	Unicode 出力モードを指定します。 BCP.EXE の –w オプション、および eUserDataType プロパティを BCP_TYPE_SQLNCHAR に設定した IBCPSession::BCPColFmt に相当します。
BCP_OUT_NATIVE_TEXT_MODE	文字型以外にネイティブ型を指定し、文字型に Unicode を指定します。 BCP.EXE の –N オプションに相当します。および、列の型が文字列の場合は BCP_TYPE_SQLNCHAR に、列の型が文字列で以外の場合は BCP_TYPE_DEFAULT に設定した eUserDataType プロパティを持つ IBCPSession::BCPColFmt に相当します。
BCP_OUT_NATIVE_MODE	ネイティブデータベース型を指定します。 BCP.EXE の –n オプション、および eUserDataType プロパティを BCP_TYPE_DEFAULT に設定した IBCPSession::BCPColFmt に相当します。

IBCPSession2::BCPSetBulkMode と競合しない IBCPSession::BCPControl オプションを指定して IBCPSession::BCPControl と IBCPSession2::BCPSetBulkMode を呼び出すことができます。たとえば、BCP_OPTION_FIRST を指定した IBCPSession::BCPControl、および IBCPSession2::BCPSetBulkMode を呼び出すことができます。

BCP_OPTION_TEXTFILE を指定した IBCPSession::BCPControl、および IBCPSession2::BCPSetBulkMode を呼び出すことはできません。

IBCPSession::BCPColFmt、IBCPSession::BCPControl、および IBCPSession::BCPReadFmt を含む関数呼び出しのシーケンスと共に IBCPSession2::BCPSetBulkMode を呼び出そうとすると、いずれかの関数呼び出しによりシーケンスエラーが返されます。このエラーを解決するには、IBCPSession::BCPInit を呼び出して設定をリセットし、最初からやり直してください。

次の表に、関数のシーケンスエラーが発生する関数呼び出しの例をいくつか示します。

呼び出しシーケンス
`BCPInit("table", "dataFile", "errorFile", BCP_DIRECTION_IN); BCPSetBulkMode();`
`BCPInit("table", "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPSetBulkMode(); BCPReadFmt();`
`BCPInit(NULL, "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPControl(BCP_OPTION_HINTS, "select …"); BCPSetBulkMode();`
`BCPInit("table", "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPSetBulkMode(); BCPColFmt();`
`BCPInit("table", "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPControl(BCP_OPTION_DELAYREADFMT, true); BCPReadFmt(); BCPColFmt();`
`BCPInit(NULL, "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPControl(BCP_OPTION_DELAYREADFMT, true); BCPSetBulkMode(); BCPControl(BCP_OPTION_HINTS, "select …"); BCPReadFmt();`
`BCPInit("table", "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPControl(BCP_OPTION_DELAYREADFMT, true); BCPColumns();`
`BCPInit("table", "dataFile", "errorFile", BCP_DIRECTION_OUT); BCPControl(BCP_OPTION_DELAYREADFMT, true); BCPSetColFmt();`

使用例

次のサンプルでは、IBCPSession2::BCPSetBulkMode の異なる設定を使用して、4 つのファイルを作成します。

// compile with: sqlncli11.lib oleaut32.lib ole32.lib

#include <stdio.h>
#include "sqlncli.h"

IDBInitialize*  g_pIDBInitialize = NULL;
IBCPSession2 * g_pIBcpSession = NULL;
class COLEDBPropSet : public DBPROPSET {
public:
   COLEDBPropSet() {
      rgProperties = NULL;
      cProperties = 0;
   };
   COLEDBPropSet(const GUID& guid) {
      rgProperties = NULL;
      cProperties = 0;
      guidPropertySet = guid;
   };
   ~COLEDBPropSet() {
      for ( ULONG i = 0 ; i < cProperties ; i++ )
         VariantClear(&rgProperties[i].vValue);
      CoTaskMemFree(rgProperties);
   }
   void SetGUID(const GUID& guid) {
      guidPropertySet = guid;
   };
   bool AddProperty(DWORD dwPropertyID, bool bValue) {
      if (!Add())
         return false;
      rgProperties[cProperties].dwPropertyID = dwPropertyID;
      rgProperties[cProperties].vValue.vt = VT_BOOL;
      rgProperties[cProperties].vValue.boolVal = (bValue) ? VARIANT_TRUE : VARIANT_FALSE;
      cProperties++;
      return true;
   };
   bool AddProperty(DWORD dwPropertyID, long nValue) {
      if (!Add())
         return false;
      rgProperties[cProperties].dwPropertyID  = dwPropertyID;
      rgProperties[cProperties].vValue.vt     = VT_I4;
      rgProperties[cProperties].vValue.lVal   = nValue;
      cProperties++;
      return true;
   };
   bool AddProperty(DWORD dwPropertyID,LPCWSTR szValue) {
      if (!Add())
         return false;
      rgProperties[cProperties].dwPropertyID = dwPropertyID;
      rgProperties[cProperties].vValue.vt = VT_BSTR;
      rgProperties[cProperties].vValue.bstrVal = SysAllocString(szValue);
      cProperties++;
      return true;
   };
   bool Add() {
      DBPROP* p = (DBPROP*)CoTaskMemRealloc(rgProperties, (cProperties + 1) * sizeof(DBPROP));
      if (p != NULL) {
         rgProperties = p;
         rgProperties[cProperties].dwOptions = DBPROPOPTIONS_REQUIRED;
         rgProperties[cProperties].colid = DB_NULLID;
         rgProperties[cProperties].vValue.vt = VT_EMPTY;
         return true;
      }
      else
         return false;
   };
};

void OLEDBCleanUp() {
   if (g_pIDBInitialize) {
      g_pIDBInitialize->Release();
      g_pIDBInitialize = NULL;
   }
   if (g_pIBcpSession) {
      g_pIBcpSession->Release();
      g_pIBcpSession = NULL;
   }
}

BOOL MakeOLEDBConnect(LPWSTR  pServer) {
   BOOL ret = true;
   IDBProperties * pIDBProperties = NULL;
   IDBCreateSession * pIDBCreateSession = NULL;
   COLEDBPropSet PropSet(DBPROPSET_DBINIT);
   COLEDBPropSet BcpProperty(DBPROPSET_SQLSERVERDATASOURCE);
   try {
      HRESULT hr = CoInitializeEx(NULL,COINIT_MULTITHREADED); 
      hr = CoCreateInstance(SQLNCLI_CLSID, NULL, CLSCTX_INPROC_SERVER, IID_IDBInitialize, (LPVOID *)&g_pIDBInitialize);
      if (FAILED(hr)) {
         printf("CoCreateInstance failed\n");
         return false;
      }
      PropSet.AddProperty(DBPROP_INIT_DATASOURCE, (LPWSTR)pServer);
      PropSet.AddProperty(DBPROP_AUTH_INTEGRATED, L"SSPI");
      hr = g_pIDBInitialize->QueryInterface(IID_IDBProperties, (void**) &pIDBProperties);
      if (FAILED(hr)) {
         printf("g_pIDBInitialize->->QueryInterface(IID_IDBProperties...) failed\n");
         throw false;
      }
      hr = pIDBProperties->SetProperties(1, &PropSet);
      if (FAILED(hr)) {
         printf("g_pIDBInitialize->->SetProperties(...) failed\n");
         throw false;
      }
      hr = g_pIDBInitialize->Initialize();
      if (FAILED(hr)) {
         printf("g_pIDBInitialize->->Initialize() failed\n");
         throw false;
      }
      BcpProperty.AddProperty(SSPROP_ENABLEFASTLOAD, true);
      BcpProperty.AddProperty(SSPROP_ENABLEBULKCOPY, true);
      hr = pIDBProperties->SetProperties(1, &BcpProperty);
      if (FAILED(hr)) {
         printf("g_pIDBInitialize->->SetProperties() for bcp failed\n");
         throw false;
      }
      hr = g_pIDBInitialize->QueryInterface(IID_IDBCreateSession, (void**) &pIDBCreateSession);
      if (FAILED(hr)) {
         printf("g_pIDBInitialize->QueryInterface(IID_IDBCreateSession..) failed\n");
         throw false;
      }

      hr = pIDBCreateSession->CreateSession(NULL, IID_IBCPSession2, (IUnknown**) &g_pIBcpSession);
      if (FAILED(hr)) {
         printf("g_pIDBCreateSession->CreateSession() failed\n");
         throw false;
      }
   }
   catch(...) {
      ret = false;
   }
   if (pIDBProperties)
      pIDBProperties->Release();
   if (pIDBCreateSession)
      pIDBCreateSession->Release();
   return ret;
}

BOOL BCPSetBulkMode(LPWSTR pszServer, LPTSTR pszQureryOut, char BCPType, LPWSTR pszDataFile) {
   HRESULThr;
   if (!MakeOLEDBConnect(pszServer))
      return false;
   hr = g_pIBcpSession->BCPInit(NULL, pszDataFile, NULL, BCP_DIRECTION_OUT );   // bcp init for queryout
   if (FAILED(hr)) {
      printf("BCP init failed\n");
      OLEDBCleanUp();
      return false;
   }
   // setbulkmode
   char ColTerm[] = "\t";
   char RowTerm[] = "\r\n";
   wchar_t wColTerm[] = L"\t";
   wchar_t wRowTerm[] = L"\r\n";
   BYTE * pColTerm = NULL;
   int cbColTerm = NULL;
   BYTE * pRowTerm = 0;
   int cbRowTerm = 0;
   int bulkmode = -1;

   if(BCPType == 'c') {   // bcp -c
      pColTerm = (BYTE*)ColTerm;
      pRowTerm = (BYTE*)RowTerm;
      cbColTerm = 1;
      cbRowTerm = 2;
      bulkmode = BCP_OUT_CHARACTER_MODE;
   }
   else
      if(BCPType == 'w') {   // bcp -w
         pColTerm = (BYTE*)wColTerm;
         pRowTerm = (BYTE*)wRowTerm;
         cbColTerm = 2;
         cbRowTerm = 4;
         bulkmode = BCP_OUT_WIDE_CHARACTER_MODE;
      }
      else
         if (BCPType == 'n')   // bcp -n
            bulkmode = BCP_OUT_NATIVE_MODE;
         else
            if (BCPType == 'N')   // bcp -n
               bulkmode = BCP_OUT_NATIVE_TEXT_MODE;
            else {
               printf("unknown bcp mode\n");
               OLEDBCleanUp();
               return false;
            }
            hr = g_pIBcpSession->BCPSetBulkMode(bulkmode, pColTerm, cbColTerm, pRowTerm, cbRowTerm);
            if (FAILED(hr)) {
               printf("BCPSetBulkMode failed\n");
               OLEDBCleanUp();
               return false;
            }

            // set queryout TSQL statement
            hr = g_pIBcpSession->BCPControl(BCP_OPTION_HINTS, pszQureryOut);
            if (FAILED(hr)) {
               printf("BCPControl failed\n");
               OLEDBCleanUp();
               return false;
            }
            // bcp copy
            DBROWCOUNT nRowsInserted = 0;
            hr = g_pIBcpSession->BCPExec(&nRowsInserted);
            if (FAILED(hr)) {
               printf("BCPExec failed\n");
               OLEDBCleanUp();
               return false;
            }
            printf("bcp done\n");
            OLEDBCleanUp();
            return true;
}

int main() {
   BCPSetBulkMode(L"localhost", TEXT("SELECT 'this is a bcp -c test', 1,2") , 'c', L"bcpc.dat");
   BCPSetBulkMode(L"localhost", TEXT("SELECT 'this is a bcp -w test', 1,2") , 'w', L"bcpw.dat");
   BCPSetBulkMode(L"localhost", TEXT("SELECT 'this is a bcp -c test', 1,2") , 'n', L"bcpn.dat");
   BCPSetBulkMode(L"localhost", TEXT("SELECT 'this is a bcp -w test', 1,2") , 'N', L"bcp_N.dat");
}

次の方法で共有

IBCPSession2::BCPSetBulkMode

構文

引数

戻り値

説明

使用例

関連項目

その他の技術情報

その他のリソース