SQLPoolConnect, fonction

Article
05/23/2023

Conformité
Version introduite : Conformité aux normes ODBC 3.8 : ODBC

Résumé
SQLPoolConnect est utilisé pour créer une connexion si aucune connexion dans le pool ne peut être réutilisée.

Syntaxe

  
SQLRETURN  SQLPoolConnect(  
                SQLHDBC              hDbc,  
                SQLHDBC_INFO_TOKEN   hDbcInfoToken,  
                WCHAR *              wszOutConnectString,  
                SQLSMALLINT          cchConnectStringBuffer,  
                SQLSMALLINT *        cchConnectStringLen );

Arguments

Hdbc
[Entrée] Handle de connexion.

hDbcInfoToken
[Entrée] Handle de jeton pour la nouvelle demande de connexion d’application.

wszOutConnectString
[Sortie] Pointeur vers une mémoire tampon pour la chaîne de connexion terminée. En cas de connexion réussie à la source de données cible, cette mémoire tampon contient la chaîne de connexion terminée. Les applications doivent allouer au moins 1 024 caractères pour cette mémoire tampon.

Si wszOutConnectString a la valeur NULL, cchConnectStringLen retourne toujours le nombre total de caractères (à l’exclusion du caractère d’arrêt null pour les données de caractères) disponibles dans la mémoire tampon pointée par wszOutConnectString.

cchConnectStringBuffer
[Entrée] Longueur de la mémoire tampon *wszOutConnectString , en caractères.

cchConnectStringLen
[Sortie] Pointeur vers une mémoire tampon dans laquelle retourner le nombre total de caractères (à l’exclusion du caractère de terminaison null) disponibles pour retourner dans *wszOutConnectString. Si le nombre de caractères disponibles à retourner est supérieur ou égal à cchConnectStringBuffer, la chaîne de connexion terminée dans *wszOutConnectString est tronquée en cchConnectStringBuffer moins la longueur d’un caractère de terminaison null.

Retours

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR ou SQL_INVALID_HANDLE.

Diagnostics

Semblable à SQLDriverConnect pour toute erreur de validation d’entrée, sauf que le Gestionnaire de pilotes utilise un HandleType de SQL_HANDLE_DBC_INFO_TOKEN et un Handle de hDbcInfoToken.

Remarques

Le Gestionnaire de pilotes garantit que le handle HENV parent de hDbc et hDbcInfoToken sont identiques.

Contrairement à SQLDriverConnect, il n’existe aucun argument DriverCompletion pour inviter les utilisateurs à entrer des informations de connexion. Une boîte de dialogue d’invite est interdite dans le scénario de regroupement.

Les applications ne doivent pas appeler cette fonction directement. Un pilote ODBC qui prend en charge le regroupement de connexions prenant en charge les pilotes doit implémenter cette fonction.

Chaque fois qu’un pilote retourne SQL_ERROR ou SQL_INVALID_HANDLE, le Gestionnaire de pilotes renvoie l’erreur à l’application (dans SQLConnect ou SQLDriverConnect).

Chaque fois qu’un pilote retourne SQL_SUCCESS_WITH_INFO, le Gestionnaire de pilotes obtient les informations de diagnostic à partir de hDbcInfoToken et retourne SQL_SUCCESS_WITH_INFO à l’application dans SQLConnect et SQLDriverConnect.

Lorsqu’une application utilise SQLConnect, wszOutConnectString est une mémoire tampon NULL (les trois derniers paramètres sont tous définis sur NULL, 0, NULL). Sinon, le pilote doit retourner la chaîne de connexion de sortie, qui sera retournée à l’appel de la fonction SQLDriverConnect de l’application.

Incluez sqlspi.h pour le développement de pilotes ODBC.

Voir aussi

Développement d’un pilote ODBC
Regroupement de connexions prenant en charge les pilotes
Développement de la reconnaissance des pools de connexions dans un pilote ODBC

Partager via