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

Статья
07/04/2024

Применимо: SQL Server База данных SQL Azure Управляемый экземпляр SQL Azure azure Synapse Analytics Analytics Platform 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 BCPReadFmt(   
      const wchar_t *pwszFormatFile);

Замечания

Метод BCPReadFmt используется для считывания данных из файла форматирования, указывающего формат данных в файле данных. Данный метод способен определить правильную версию файла форматирования. Он может автоматически определить, в каком формате находится файл форматирования — XML или формат текста по старому стилю, —и действовать соответствующим образом. Версии файлов форматирования, поддерживаемые поставщиком OLE DB для собственного клиента SQL Server, являются версией 6.0 или более поздней.

После того как метод BCPReadFmt считывает значения формата, он выполняет соответствующие вызовы методов IBCPSession::BCPColumns и IBCPSession::BCPColFmt. Пользователю не требуется производить анализ файла форматирования и выполнять эти вызовы.

Чтобы сохранить файл форматирования, вызовите метод IBCPSession::BCPWriteFmt. Вызовы метода BCPReadFmt могут ссылаться на сохраненные форматы. Кроме того, программа массового копирования (bcp) может сохранять определяемые пользователем форматы данных в файлах, на которые может ссылаться метод BCPReadFmt .

Значение BCP_OPTION_DELAYREADFMT для параметра eOption в IBCPSession::BCPControl изменяет поведение IBCPSession::BCPReadFmt.

Аргументы

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

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

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

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

E_OUTOFMEMORY
Ошибка, связанная с нехваткой памяти.

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

См. также

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

Поделиться через