IBCPSession::BCPReadFmt (Provedor OLE DB do cliente nativo)

Aplica-se a: SQL Server Banco de Dados SQL do Azure Instância Gerenciada de SQL do Azure PDW (Sistema de Plataforma de Análise) do Azure Synapse Analytics

Importante

O SQL Server Native Client (geralmente abreviado como SNAC) foi removido do SQL Server 2022 (16.x) e do SSMS (SQL Server Management Studio) 19. O provedor OLE DB do SQL Server Native Client (SQLNCLI ou SQLNCLI11) e o Provedor OLE DB herdado da Microsoft para o SQL Server (SQLOLEDB) não são recomendados para um novo desenvolvimento. Alterne para o novo Driver do Microsoft OLE DB para SQL Server (MSOLEDBSQL) no futuro.

Lê informações de formato relativas a cada coluna no arquivo de formato.

Sintaxe

  
HRESULT BCPReadFmt(   
      const wchar_t *pwszFormatFile);  

Comentários

O método BCPReadFmt é usado para ler dados de um arquivo de formato que especifica o formato de dados no arquivo de dados. Este método é capaz de detectar a versão correta do arquivo de formato. Ele pode detectar automaticamente se o arquivo de formato está em xml ou formato de texto de estilo antigo e se comporta adequadamente. As versões de arquivo de formato compatíveis com o BCP do provedor OLE DB do SQL Server Native Client são a versão 6.0 ou mais recente.

Depois que o método BCPReadFmt lê os valores de formato, ele faz as chamadas apropriadas aos métodos IBCPSession::BCPColumns e IBCPSession::BCPColFmt. Não há necessidade de o usuário analisar um arquivo de formato e fazer essas chamadas.

Para salvar um arquivo de formato, chame o método IBCPSession::BCPWriteFmt. As chamadas ao método BCPReadFmt podem referenciar formatos salvos. Como alternativa, o utilitário de cópia em massa (bcp) pode salvar formatos de dados definidos pelo usuário em arquivos que podem ser referenciados pelo método BCPReadFmt .

O valor BCP_OPTION_DELAYREADFMT do parâmetro eOption de IBCPSession::BCPControl modifica o comportamento de IBCPSession::BCPReadFmt.

Argumentos

pwszFormatFile[in]
O caminho e o nome do arquivo que contém os valores de formato do arquivo de dados.

Valores do código de retorno

S_OK
O método foi bem-sucedido.

E_FAIL
Erro específico do provedor. Para obter informações detalhadas, use a interface ISQLServerErrorInfo.

E_OUTOFMEMORY
Erro de memória insuficiente.

E_UNEXPECTED
A chamada para o método era inesperada. Por exemplo, o método IBCPSession::BCPInit não foi chamado antes desse método.

Consulte Também

IBCPSession (OLE DB)
Executando operações de cópia em massa