IBCPSession2::BCPSetBulkMode

Интерфейс IBCPSession2::BCPSetBulkMode предоставляет альтернативу интерфейсу IBCPSession::BCPColFmt (OLE DB) для указания формата столбца. В отличие от интерфейса 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). Это приведет к тому, что интерфейс ICommandPrepare::Prepare возвратит ошибку, которая не позволит получить данные. Если в рамках одной команды требуется объединить выполнение хранимой процедуры и пакетный запрос, то следует использовать синтаксис ODBC CALL (например, {call func}; SELECT * from Tbl).

В следующей таблице перечислены константы для параметра property.

Свойство	Описание
BCP_OUT_CHARACTER_MODE	Указывает символьный режим вывода. Соответствует параметру -c в программе BCP.EXE и вызову IBCPSession::BCPColFmt с установкой свойства eUserDataType в значение BCP_TYPE_SQLCHARACTER.
BCP_OUT_WIDE_CHARACTER_MODE	Указывает режим вывода в Юникоде. Соответствует параметру -w в программе BCP.EXE и вызову IBCPSession::BCPColFmt с установкой свойства eUserDataType в значение BCP_TYPE_SQLNCHAR.
BCP_OUT_NATIVE_TEXT_MODE	Указывает собственные типы для несимвольных типов и Юникод для символьных типов. Соответствует параметру –N в BCP.EXE и IBCPSession::BCPColFmt, свойству eUserDataType которого задано значение BCP_TYPE_SQLNCHAR, если типом столбца является строка, или BCP_TYPE_DEFAULT, если не строка.
BCP_OUT_NATIVE_MODE	Указывает типы данных базы данных. Соответствует параметру -n в программе BCP.EXE и IBCPSession::BCPColFmt, свойству eUserDataType которого задано значение BCP_TYPE_DEFAULT.

Можно вызвать IBCPSession::BCPControl и IBCPSession2::BCPSetBulkMode для параметров IBCPSession::BCPControl, которые не конфликтуют с IBCPSession2::BCPSetBulkMode. Например, можно вызвать IBCPSession::BCPControl с BCP_OPTION_FIRST и IBCPSession2::BCPSetBulkMode.

Нельзя вызвать IBCPSession::BCPControl с BCP_OPTION_TEXTFILE и IBCPSession2::BCPSetBulkMode.

При попытке вызвать IBCPSession2::BCPSetBulkMode с последовательностью вызовов функций, который включает IBCPSession::BCPColFmt, IBCPSession::BCPControl и IBCPSession::BCPReadFmt, один из вызовов функций вернет ошибку последовательности. Если необходимо исправить ошибку, вызовите 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.

// 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 (OLE DB)

Last updated on 2013-05-07