IBCPSession::BCPReadFmt (fournisseur OLE DB Native Client)

S’applique à :SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

Important

SQL Server Native Client (souvent abrégé en SNAC) a été supprimé dans SQL Server 2022 (16.x) et SQL Server Management Studio 19 (SSMS). Le fournisseur OLE DB pour SQL Server Native Client (SQLNCLI ou SQLNCLI11) et le fournisseur Microsoft OLE DB hérité pour SQL Server (SQLOLEDB) ne sont pas recommandés dans les nouveaux développements. Utilisez à la place le nouveau Microsoft OLE DB Driver (MSOLEDBSQL) pour SQL Server.

Lit les informations de format pour chaque colonne à partir du fichier de format.

Syntaxe

  
HRESULT BCPReadFmt(   
      const wchar_t *pwszFormatFile);  

Notes

La méthode BCPReadFmt est utilisée pour lire les données d'un fichier de format qui spécifie le format des données dans le fichier de données. Cette méthode est capable de détecter la version correcte du fichier de format. Elle peut détecter automatiquement si le fichier de format est au format xml ou dans un ancien format et qu'il se comporte en conséquence. Les versions de fichier de format prises en charge par le SQL Server Native Client fournisseur OLE DB BCP sont la version 6.0 ou ultérieure.

Après avoir lu les valeurs de format, la méthode BCPReadFmt effectue les appels appropriés aux méthodes IBCPSession::BCPColumns et IBCPSession::BCPColFmt. L'utilisateur n'a pas besoin d'analyser un fichier de format et d'effectuer ces appels.

Pour enregistrer un fichier de format, appelez la méthode IBCPSession::BCPWriteFmt. Les appels à la méthode BCPReadFmt peuvent référencer des formats enregistrés. L'utilitairebcppeut également enregistrer des formats de données définis par l'utilisateur dans des fichiers qui peuvent être référencés par la méthode BCPReadFmt .

La valeur BCP_OPTION_DELAYREADFMT du paramètre eOption de IBCPSession::BCPControl modifie le comportement de IBCPSession::BCPReadFmt.

Arguments

pwszFormatFile[in]
Chemin d'accès et nom du fichier contenant les valeurs de format du fichier de données.

Codet de retour

S_OK
S_OK

E_FAIL
Une erreur spécifique au fournisseur s’est produite. Pour obtenir des informations détaillées, utilisez l’interface ISQLServerErrorInfo.

E_OUTOFMEMORY
Erreur de mémoire insuffisante.

E_UNEXPECTED
L'appel à la méthode était inattendu. Par exemple, la méthode IBCPSession::BCPInit n’a pas été appelée avant d’appeler cette méthode.

Voir aussi

IBCPSession (OLE DB)
Exécution d'opérations de copie en bloc