IBCPSession::BCPReadFmt (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.

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

Sintaxis

  
HRESULT BCPReadFmt(   
      const wchar_t *pwszFormatFile);  

Observaciones

El método BCPReadFmt se utiliza para leer datos de un archivo de formato que especifica el formato de datos en el archivo de datos. Este método es capaz de detectar la versión correcta del archivo de formato. Puede detectar automáticamente si el archivo de formato está en xml o en el formato de texto de estilo anterior y se comporta en consecuencia. Las versiones de archivo de formato compatibles con el proveedor OLE DB SQL Server Native Client BCP son la versión 6.0 o posterior.

Después de que el método BCPReadFmt lee los valores de formato, realiza las llamadas adecuadas a los métodos IBCPSession::BCPColumns e IBCPSession::BCPColFmt. No es necesario que analice un archivo de formato y realice estas llamadas.

Para guardar un archivo de formato, llame al método IBCPSession::BCPWriteFmt. Las llamadas al método BCPReadFmt pueden hacer referencia a formatos guardados. Como alternativa, la utilidad de copia masiva (bcp) puede guardar formatos de datos definidos por el usuario en archivos a los que puede hacer referencia el método BCPReadFmt .

El valor BCP_OPTION_DELAYREADFMT del parámetro eOption de IBCPSession::BCPControl modifica el comportamiento de 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