IBCPSession::BCPWriteFmt (provedor OLE DB de cliente nativo)

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do AzureAzure Synapse AnalyticsPDW (Analytics Platform System)

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.

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

Sintaxe

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);  

Comentários

O arquivo de formato especifica o formato de dados de um arquivo de dados criado por cópia em massa. As chamadas aos métodos IBCPSession::BCPColumns e IBCPSession::BCPColFmt definem o formato do arquivo de dados. O método BCPWriteFmt salva essa definição no arquivo referenciado pelo argumento pwszFormatFile.

O método BCPWriteFmt pode salvar os arquivos de formato em xml ou formato de texto. Isso precisa ser indicado usando a opção de controle BCP_OPTION_XML com o método IBCPSession::BCPControl.

Para carregar um arquivo de formato salvo, use o método 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
Um erro específico do provedor ocorreu. 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