IBCPSession::BCPWriteFmt (поставщик OLE DB собственного клиента)

  • Статья

Применимо к:SQL ServerAzure SQL DatabaseAzure Managed InstanceAzure Synapse Analytics AnalyticsPlatform System (PDW)

Внимание

Собственный клиент SQL Server (часто сокращенный SNAC) был удален из SQL Server 2022 (16.x) и SQL Server Management Studio 19 (SSMS). Поставщик OLE DB собственного клиента SQL Server (SQLNCLI или SQLNCLI11) и устаревший поставщик Microsoft OLE DB для SQL Server (SQLOLEDB) не рекомендуется для новой разработки. Перейдите на новый драйвер Microsoft OLE DB (MSOLEDBSQL) для SQL Server .

Записывает в файл форматирования сведения о формате каждого из столбцов.

Синтаксис

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);

Замечания

Файл форматирования определяет формат данных, содержащихся в файле данных, создаваемом при массовом копировании. Вызовы методов IBCPSession::BCPColumns и IBCPSession::BCPColFmt определяют формат файла данных. Метод BCPWriteFmt сохраняет это определение в файле, на который ссылается аргумент pwszFormatFile.

Метод BCPWriteFmt может сохранять файлы форматирования в формате xml или текстовом формате. Это должно определяться с помощью параметра управления BCP_OPTION_XML методом IBCPSession::BCPControl.

Для загрузки сохраненного файла форматирования используется метод IBCPSession::BCPReadFmt.

Аргументы

pwszFormatFile[in]
Путь и имя файла, содержащего значения формата для файла данных.

Значения кода возврата

S_OK
Метод выполнен успешно.

E_FAIL
Произошла ошибка, связанная с поставщиком. Подробные сведения можно получить при помощи интерфейса ISQLServerErrorInfo.

E_OUTOFMEMORY
Недостаточно памяти.

E_UNEXPECTED
Непредвиденный вызов метода. Например, перед вызовом этого метода не был вызван метод IBCPSession::BCPInit.

См. также

IBCPSession (OLE DB)
Выполнение операций массового копирования