bcp_colfmt

Syntaxe

RETCODE bcp_colfmt (
        HDBC hdbc,
        INT idxUserDataCol,
        BYTE eUserDataType,
        INT cbIndicator,
        DBINT cbUserData,
        LPCBYTE pUserDataTerm,
        INT cbUserDataTerm,
        INT idxServerCol);

Arguments

• hdbc
  Handle de connexion ODBC compatible avec la copie en bloc.

• idxUserDataCol
  Numéro de colonne ordinal dans le fichier des données utilisateur pour lequel le format est spécifié. La première colonne est 1.

• eUserDataType
  Type de données de la colonne dans le fichier utilisateur. Si le type de données est différent de celui de la colonne correspondante dans la table de base de données (idxServerColumn), la copie en bloc convertit si possible les données.

  SQL Server 2005 a introduit la prise en charge des jetons de type de données SQLXML et SQLUDT dans le paramètre eUserDataType.

  Le paramètre eUserDataType est énuméré par les jetons de type de données SQL Server dans sqlncli.h, et non par les énumérateurs de type de données C ODBC. Par exemple, vous pouvez spécifier une chaîne de caractères, ODBC type SQL_C_CHAR, à l'aide du SQLCHARACTER de type propre à SQL Server.

  Pour spécifier la représentation des données par défaut pour le type de données SQL Server, définissez ce paramètre avec la valeur 0.

  Pour une copie en bloc à partir de SQL Server dans un fichier, lorsque eUserDataType est de type SQLDECIMAL ou SQLNUMERIC :

  • Si la colonne source n'est pas décimale ou numérique, la précision et l'échelle par défaut sont utilisées.

  • Si la colonne source est décimale ou numérique, la précision et l'échelle de la colonne source sont utilisées.

• cbIndicator
  Longueur, en octets, d'une longueur/indicateur null au sein des données de la colonne. Les valeurs de longueur d'indicateur valides sont 0 (quand aucun indicateur n'est utilisé), 1, 2, 4 ou 8.

  Pour spécifier l'utilisation d'un indicateur de copie en bloc par défaut, définissez ce paramètre sur SQL_VARLEN_DATA.

  Les indicateurs apparaissent directement en mémoire avant les autres données et, dans le fichier de données, directement avant les données auxquelles ils s'appliquent.

  Si plusieurs méthodes de spécification de la longueur de colonne d'un fichier de données sont utilisées (par exemple un indicateur et une longueur de colonne maximale, ou un indicateur et une marque de fin), la copie en bloc choisit celle qui implique la quantité de données à copier la moins élevée.

  Les fichiers de données générés par la copie en bloc lorsqu'aucune intervention de l'utilisateur n'ajuste le format des données contiennent des indicateurs si les données de la colonne peuvent varier en longueur ou que la colonne peut accepter NULL comme valeur.

• cbUserData
  Longueur maximale, en octets, des données de cette colonne dans le fichier utilisateur, sans compter la longueur d'un indicateur de longueur ou d'un terminateur.

  L'attribution de SQL_NULL_DATA à cbUserData indique que toutes les valeurs de la colonne du fichier de données sont ou doivent être NULL.

  L'attribution de SQL_VARLEN_DATA à cbUserData indique que le système doit déterminer la longueur des données dans chaque colonne. Pour certaines colonnes, cela peut signifier qu'un indicateur de longueur/null est généré pour précéder les données sur une copie à partir de SQL Server ou que l'indicateur est attendu dans les données copiées vers SQL Server.

  Pour les types de données SQL Server character et binary, cbUserData peut avoir la valeur SQL_VARLEN_DATA, SQL_NULL_DATA, 0 ou une valeur positive quelconque. Si cbUserData a la valeur SQL_VARLEN_DATA, le système utilise l'indicateur de longueur, s'il est présent, ou une séquence de terminaison pour déterminer la longueur des données. Si un indicateur de longueur et une séquence de terminaison sont fournis, la copie en bloc utilise celui qui génère la plus petite quantité de données à copier. Si cbUserData a la valeur SQL_VARLEN_DATA, le type de données est un type SQL Server character ou binary, et si aucun indicateur de longueur ou séquence de terminaison n'est spécifié, le système retourne un message d'erreur.

  Si cbUserData a la valeur 0 ou une valeur positive, le système utilise cbUserData comme longueur de données maximale. Toutefois, si un indicateur de longueur ou une séquence de terminaison est fournie en plus d'une valeur cbUserData positive, le système détermine la longueur de données en utilisant la méthode qui entraîne la plus petite quantité de données à copier.

  La valeur cbUserData représente le nombre d'octets de données. Si des données caractères sont représentées par des caractères Unicode étendus, une valeur de paramètre cbUserData positive représente le nombre de caractères multiplié par la taille, en octets, de chaque caractère.

• pUserDataTerm
  Séquence de terminaison à utiliser pour cette colonne. Ce paramètre est principalement utile pour les types de données caractères, car tous les autres types sont de longueur fixe ou, dans le cas de données binaires, nécessitent un indicateur de longueur pour enregistrer correctement le nombre d'octets présents.

  Pour éviter de terminer des données extraites ou pour indiquer que les données dans un fichier utilisateur ne sont pas terminées, attribuez à ce paramètre la valeur NULL.

  Si plusieurs méthodes de spécification de la longueur de colonne de fichier utilisateur sont utilisées (par exemple une marque de fin et un indicateur de longueur, ou une marque de fin et une longueur de colonne maximale), la copie en bloc choisit celle qui entraîne le moins de données à copier.

  L'interface de programmation d'application (API) de copie en bloc effectue la conversion de caractères Unicode vers MBCS en fonction des besoins. Vous devez veiller à définir correctement la chaîne d'octet de marque de fin et la longueur de la chaîne d'octets.

• cbUserDataTerm
  Longueur, en octets, de la séquence de marque de fin à utiliser pour la colonne. Si aucune marque de fin n'est présente ou désirée dans les données, attribuez 0 à cette valeur.

• idxServerCol
  Position ordinale de la colonne dans la table de base de données. Le premier numéro de colonne est 1. La position ordinale d'une colonne est indiquée par SQLColumns.

  Si cette valeur est 0, la copie en bloc ignore la colonne dans le fichier de données.

Valeurs retournées

SUCCEED ou FAIL.

Notes

La fonction bcp_colfmt permet de spécifier le format du fichier utilisateur pour les copies en bloc. Pour la copie en bloc, un format se compose des éléments suivants :

• un mappage des colonnes du fichier d'utilisateur avec les colonnes de base de données ;

• le type de données de chaque colonne du fichier utilisateur ;

• la longueur de l'indicateur facultatif pour chaque colonne ;

• la longueur maximale des données par colonne du fichier utilisateur ;

• la séquence d'octets de fin facultative pour chaque colonne ;

• la longueur de la séquence d'octets de fin facultative.

Chaque appel à bcp_colfmt spécifie le format pour une colonne du fichier utilisateur. Par exemple, pour modifier les paramètres par défaut de trois colonnes d'un fichier de données utilisateur de cinq colonnes, appelez d'abord bcp_columns(5), puis bcp_colfmt cinq fois (trois de ces appels définissant votre format personnalisé). Pour les deux appels restants, définissez eUserDataType avec la valeur 0 et définissez respectivement cbIndicator, cbUserData et cbUserDataTerm avec les valeurs 0, SQL_VARLEN_DATA et 0. Cette procédure copie les cinq colonnes, trois avec votre format personnalisé et deux avec le format par défaut.

Pour cbIndicator, la valeur 8 pour indiquer un type valeur élevé est désormais valide. Si le préfixe est spécifié pour un champ dont la colonne correspondante est un nouveau type max, il ne peut avoir que la valeur 8. Pour plus d'informations, consultez bcp_bind.

La fonction bcp_columns doit être appelée avant tout appel de bcp_colfmt.

Vous devez appeler bcp_colfmt une fois pour chaque colonne dans le fichier utilisateur.

Le fait d'appeler bcp_colfmt plus d'une fois pour une colonne de fichier utilisateur génère une erreur.

Vous n'avez pas besoin de copier toutes les données d'un fichier utilisateur dans la table SQL Server. Pour ignorer une colonne, spécifiez le format des données de la colonne, en attribuant la valeur 0 au paramètre idxServerCol. Si vous souhaitez ignorer une colonne, vous devez spécifier son type.

La fonction bcp_writefmt peut être utilisée pour assurer la persistance de la spécification de format.

Prise en charge de bcp_colfmt pour les fonctionnalités Date et Heure améliorées

Pour plus d'informations sur les types utilisés avec le paramètre eUserDataType pour les types date/time, consultez Modifications de copie en bloc pour les types date/heure améliorés (OLE DB et ODBC).

Pour plus d'informations, consultez Améliorations de la date et de l'heure (ODBC).

Voir aussi

Référence