Partage via

IBCPSession ::BCPInit (fournisseur OLE DB Native Client)

  • Article

S’applique à : SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics 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.

Initialise la structure de copie en bloc, effectue une vérification des erreurs, vérifie que les données et les noms de fichiers de format sont corrects, puis les ouvre.

Syntaxe

  
HRESULT BCPInit(   
      const wchar_t *pwszTable,  
      const wchar_t *pwszDataFile,  
      const wchar_t *pwszErrorFile,  
      int eDirection);

Notes

La méthode BCPInit doit être appelée avant toute autre méthode de copie en bloc. La méthode BCPInit effectue les initialisations nécessaires pour une copie en bloc de données entre la station de travail et SQL Server.

La méthode BCPInit examine la structure de la source de base de données ou de la table cible, et non le fichier de données. Elle spécifie des valeurs de format de données pour le fichier de données en fonction de chaque colonne dans la table de base de données, la vue ou le jeu de résultats SELECT. Cette spécification inclut le type de données de chaque colonne, la présence ou l'absence d'un indicateur de longueur ou null et des chaînes d'octet de terminateur dans les données, et la largeur des types de données de longueur fixe. La méthode BCPInit définit ces valeurs de la manière suivante :

  • Le type de données spécifié est le type de données de la colonne dans la table de base de données, la vue ou le jeu de résultats SELECT. Le type de données est énuméré par les types de données natifs SQL Server spécifiés dans le fichier d’en-tête SQL Server Native Client (sqlncli.h). Leurs valeurs suivent le modèle BCP_TYPE_XXX. Les données sont représentées dans leur forme informatique. Autrement dit, les données d'une colonne de type de données integer sont représentées par une séquence de quatre octets de poids fort ou de poids faible selon l'ordinateur qui a créé le fichier de données.

  • Si un type de données de base de données est de longueur fixe, les données du fichier de données sont également de longueur fixe. Les méthodes de copie en bloc qui traitent les données (par exemple, IBCPSession::BCPExec) analysent les lignes de données en prévoyant que la longueur des données du fichier de données sera identique à la longueur des données de la table de base de données, de la vue ou de la liste de colonnes SELECT. Par exemple, les données d'une colonne de base de données définie comme char(13) doivent être représentées par 13 caractères pour chaque ligne de données du fichier. Les données de longueur fixe peuvent être préfixées avec un indicateur null si la colonne de base de données autorise les valeurs NULL.

  • Lors de la copie de données vers SQL Server, le fichier de données doit avoir les données de chaque colonne de la table de base de données. Lors de la copie de données depuis SQL Server, les données de toutes les colonnes de la table de base de données, de la vue ou du jeu de résultats SELECT, sont copiées vers le fichier de données.

  • Lors de la copie de données vers SQL Server, la position ordinale d'une colonne du fichier de données doit être identique à la position ordinale de la colonne de la table de base de données. Lors de la copie de données à partir de SQL Server, la méthode BCPExec place les données selon la position ordinale de la colonne dans la table de base de données.

  • Si un type de données de base de données est variable en longueur (par exemple, varbinary(22)) ou si une colonne de base de données peut contenir des valeurs NULL, les données du fichier de données sont préfixées par un indicateur de longueur/null. La largeur de l'indicateur varie selon le type de données et la version de la copie en bloc. L’option BCP_OPTION_FILEFMT de la méthode IBCPSession::BCPControl fournit la compatibilité entre les fichiers de données des copies en bloc antérieurs et les serveurs exécutant des versions ultérieures de SQL Server en signalant lorsque la largeur des indicateurs des données est plus étroite que prévu.

Notes

Pour modifier les valeurs de format de données spécifiées pour un fichier de données, utilisez les méthodes IBCPSession::BCPColumns et IBCPSession::BCPColFmt.

Les copies en bloc vers SQL Server peuvent être optimisées pour les tables qui ne contiennent pas d’index en définissant l’option de base de données select into/bulkcopy.

Arguments

pwszTable[in]
Nom de la table de base de données depuis ou vers laquelle s’effectue la copie. Le nom peut inclure le nom de la base de données ou le nom du propriétaire. Par exemple, « pubs.username.titles », « pubs..titles », « username.titles ».

Si l'argument eDirection a la valeur BCP_DIRECTION_OUT, l'argument pwszTable peut être le nom d'une vue de base de données.

Si l’argument eDirection a la valeur BCP_DIRECTION_OUT et qu’une instruction SELECT est spécifiée à l’aide de la méthode BCPControl avant l’appel de la méthode BCPExec, l’argument pwszTable doit avoir la valeur NULL.

pwszDataFile[in]
Nom du fichier utilisateur depuis ou vers lequel s’effectue la copie.

pwszErrorFile[in]
Nom du fichier d'erreurs à remplir avec les messages de progression, les messages d'erreur et les copies des lignes qui n'ont pas pu être copiées d'un fichier utilisateur vers une table. Si l'argument pwszErrorFile a la valeur NULL, aucun fichier d'erreurs n'est utilisé.

eDirection[in]
Direction de l'opération de copie, BCP_DIRECTION_IN ou _OUT BCP_DIRECTION. BCP_DIRECTION_IN indique une copie d'un fichier utilisateur vers une table de base de données ; BCP_DIRECTION_OUT indique une copie d'une table de base de données vers un fichier utilisateur.

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_INVALIDARG
Au moins un des arguments n'a pas été spécifié correctement. Par exemple, un nom de fichier non valide a été donné.

Voir aussi

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