IBCPSession::BCPWriteFmt (proveedor OLE DB de Native Client)

Se aplica a:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

Importante

SQL Server Native Client (a menudo abreviado SNAC) se ha quitado de SQL Server 2022 (16.x) y SQL Server Management Studio 19 (SSMS). Para nuevos trabajos de desarrollo, no se recomiendan ni el proveedor OLE DB de SQL Server Native Client (SQLNCLI o SQLNCLI11) ni el proveedor OLE DB de Microsoft para SQL Server (SQLOLEDB) heredado. Cambie al nuevo Controlador Microsoft OLE DB para SQL Server de ahora en adelante.

Escribe la información de formato de cada columna en el archivo de formato.

Sintaxis

  
HRESULT BCPWriteFmt(   
      const wchar_t *pwszFormatFile);  

Observaciones

El archivo de formato especifica el formato de los datos de un archivo de datos creado mediante copia masiva. Las llamadas a los métodos IBCPSession::BCPColumns e IBCPSession::BCPColFmt definen el formato del archivo de datos. El método BCPWriteFmt guarda esta definición en el archivo al que se hace referencia en el argumento pwszFormatFile.

El método BCPWriteFmt puede guardar los archivos de formato en formato xml o de texto. Esto se debe indicar mediante la opción de control BCP_OPTION_XML con el método IBCPSession::BCPControl.

Para cargar un archivo de formato guardado, use el método IBCPSession::BCPReadFmt.

Argumentos

pwszFormatFile[in]
La ruta de acceso y nombre del archivo que contiene los valores de formato para el archivo de datos.

Valores de código de retorno

S_OK
El método se ha llevado a cabo de forma correcta.

E_FAIL
Se produjo un error específico del proveedor; para obtener información detallada, use la interfaz ISQLServerErrorInfo.

E_OUTOFMEMORY
Error de memoria insuficiente.

E_UNEXPECTED
No se esperaba la llamada al método. Por ejemplo, no se llamó al método IBCPSession::BCPInit antes de llamar a este método.

Consulte también

IBCPSession (OLE DB)
Realizar operaciones de copia masiva