Objet Parameter (Versions 2.0, 2.1, 2.5 et 2.6)

L'objet Parameter contient des informations pour une variable dans une instruction SQL ou des procédures stockées. En combinaison, les objets Parameter appartiennent à la collection Parameters des objets Command.

Méthode Parameter.AppendChunk (Versions 2.0, 2.1, 2.5 et 2.6)

parameter.AppendChunk Data
 

La méthode AppendChunk ajoute des données à un grand champ de données ou binaire dans l'objet Parameter actuel.

Arguments
Données

Le seul paramètre, Data, est un type de données Variant qui contient la grande quantité de données à ajouter à l'objet Parameter actuel.

 
Description

La méthode AppendChunk ajoute de grandes quantités de données (de type texte ou binaire) à un objet Parameter existant. Elle peut s'avérer très pratique si le système actuel possède une quantité de mémoire limitée par rapport à la quantité requise pour l'exécution de l'opération. En employant la méthode AppendChunk, vous pouvez ajouter les données à votre objet Field par incréments, selon la manière qui vous convient le mieux.

Le bit adFldLong de la propriété Arguments appartenant à l'objet Parameter doit être défini pour que la méthode AppendChunk de l'objet Parameter puisse être appelée.

En appelant à plusieurs reprises la méthode AppendChunk pour un objet Parameter, vous ajoutez les données à celles qui figurent déjà dans cet objet. La seule manière d'effacer les données d'un objet Parameter consiste à en faire une chaîne de longueur zéro. Si vous transférez une valeur Null à la méthode AppendChunk d'un objet Parameter, vous obtiendrez un message d'erreur.

 
Voir aussi

Propriété Parameter.Arguments

 
Propriété Parameter.Attributes (Versions 2.0, 2.1, 2.5 et 2.6)

parameter.Attributes = ParameterAttributesEnum
 

La propriété Attributes permet de définir ou de renvoyer des caractéristiques spécifiques au sujet de l'objet Parameter.

Type de données

ParameterAttributesEnum (Long)

 
Description

La propriété Arguments est en lecture/écriture. La valeur de la propriété Arguments peut être fixée à n'importe quelle somme des valeurs de l'énumération ParameterArgumentsEnum figurant dans l'annexe E. La valeur par défaut de la propriété Arguments est adParamSigned.

 
Voir aussi

Énumération ParameterAttributesEnum

 
Propriété Parameter.Direction (Versions 2.0, 2.1, 2.5, 2.6)

parameter.Direction = ParameterDirectionEnum
 

La propriété Direction détermine si le paramètre actuel est un paramètre d'entrée, un paramètre de sortie, les deux à la fois ou une valeur retournée depuis une procédure stockée.

Type de données

ParameterDirectionEnum (Long)

 
Description

La propriété Direction est en lecture/écriture. Il est conseillé d'ajouter manuellement des paramètres à une collection Parameters, de manière à éviter qu'ADO doive faire des appels supplémentaires du fournisseur de données en vue de trouver ces informations. Dans certains cas, vous devez définir la propriété Direction manuellement, car il se peut que le fournisseur de données spécifique soit incapable de déterminer ces informations.

La propriété Direction peut être fixée à l'une des énumérations ParameterDirectionEnum figurant dans l'annexe E.

 
Remarque

Tous les fournisseurs ne sont pas capables de déterminer la valeur de la propriété Direction. Dès lors, pour ces fournisseurs, l'application doit fixer manuellement la valeur de la propriété Direction des paramètres avant qu'ils puissent être utilisés.

 
Voir aussi

Énumération ParameterDirectionEnum

 
Propriété Parameter.Name (Versions 2.0, 2.1, 2.5, 2.6)

parameter.Name = Name
 

La propriété Name définit le nom de l'objet Parameter actuel.

Type de données

Chaîne

 
Description

La propriété Name est en lecture/écriture pour l'objet Parameter. Vous ne pouvez définir la propriété Name que si l'objet Parameter n'a pas déjà été ajouté à une collection Parameters.

La propriété Name attribue un nom à l'objet Parameter associé ou récupère un objet Parameter de la collection Parameters.

Les noms ne doivent pas être uniques dans l'objet de la collection Parameters.

 
Propriété Parameter.NumericScale (Versions 2.0, 2.1, 2.5, 2.6)

numberscale = parameter.NumericScale
 

La propriété NumericScale indique l'échelle de valeurs numériques dans l'objet Parameter actuel.

Type de données

Octet

 
Description

La propriété NumericScale est en lecture/écriture pour l'objet Parameter. Elle sert à identifier le nombre d'octets utilisés à droite de la décimale pour un objet Parameter numérique.

 
Propriété Parameter.Precision (Versions 2.0, 2.1, 2.5, 2.6)

precision = parameter.Precision
 

La propriété Precision représente le degré de précision d'une valeur numérique dans l'objet Parameter actuel.

Type de données

Octet

 
Description

La propriété Precision est en lecture/écriture pour l'objet Parameter. Cette propriété renvoie une valeur Byte qui indique le nombre total de chiffres utilisés pour représenter une valeur pour un objet Parameter numérique.

 
Collection Parameter.Properties (Versions 2.0, 2.1, 2.5, 2.6)

Set properties = parameter.Properties
 

La collection Properties renvoie une classe de collection Properties qui contient des caractéristiques spécifiques à l'objet Parameter pour le fournisseur utilisé actuellement.

Type de données

Properties (objet Collection)

 
Description

La classe de collection Properties contient une instance de classe Property pour chaque propriété spécifique à l'objet Parameter pour le fournisseur de données.

 
Propriété Parameter.Size (Versions 2.0, 2.1, 2.5, 2.6)

parameter.Size = size
 

La propriété Size renvoie la taille maximale de la valeur d'un objet Parameter.

Type de données

Long

 
Description

La propriété Size renvoie la taille maximale de la valeur d'un paramètre, en octets. Cette propriété est en lecture/écriture.

Si un objet Parameter possède un type de données à longueur variable, la propriété Size doit être définie avant qu'il soit ajouté à une collection Parameters, faute de quoi une erreur se produira.

Si vous tentez de remplacer le type de données d'un objet Parameter par un type de données de longueur variable, veillez à définir tout d'abord la propriété Size, de manière à éviter la génération d'une erreur.

Vous devez également définir la propriété Size de l'objet Parameter avant d'appeler la méthode Execute de l'objet Command. Dans le cas contraire, s'il existe un type de données à longueur variable, ADO risque de tenter d'attribuer de la mémoire fonction de la quantité maximale requise, ce qui provoquera une erreur.

 
Propriété Parameter.Type (Versions 2.0, 2.1, 2.5, 2.6)

parameter.Type = DataTypeEnum
 

La propriété Type identifie le type de données de l'objet actuel.

Type de données

DataTypeEnum (Long)

 
Description

La propriété Type est en lecture/écriture pour l'objet Parameter. Cette propriété renvoie une valeur Byte qui indique le nombre total de chiffres utilisés pour représenter une valeur pour un objet Parameter numérique.

 
Voir aussi

Énumération DataTypeEnum

 
Propriété Parameter.Value (Versions 2.0, 2.1, 2.5, 2.6)

parameter.Value = value
 

La propriété Value indique la valeur attribuée à l'objet Parameter actuel.

Type de données

Variant

 
Description

La propriété Value lit et fixe la valeur de l'objet Parameter associé. La propriété Value prend en charge les longues données binaires via ADO.

ADO ne lit la propriété Value des objets Parameter qu'une seule fois. Si vous exécutez une commande qui contient un paramètre dont la propriété Value est vide, et qu'elle crée un jeu d'enregistrements, veillez à fermer le jeu d'enregistrements avant de lire la propriété Value.

 
Collection Parameters

Set parameters = command.Parameters
Set fields = recordset.Fields
 

Consultez la section relative à l'objet Parameters pour plus d'informations et des exemples en rapport avec la collection Parameters.

Objets
Parameter

Contient des informations au sujet d'un paramètre appartenant à une instruction, une requête ou une procédure stockée SQL.

 
Méthodes
Append

Ajoute un nouvel objet Parameter à la classe de collection Parameters actuelle.

Delete

Supprime un objet Parameter de la classe de collection Parameters.

Refresh

Actualise la collection en fonction des paramètres de la procédure stockée ou de la requête paramétrée actuellement associée à l'objet Command auquel la collection Parameters appartient.

 
Propriétés
Count

Indique le nombre d'objets Parameter appartenant à la collection Parameters associée.

Item

Permet d'accéder à un objet Parameter spécifique appartenant à la collection Parameters.

 
Méthode Parameters.Append (Versions 2.0, 2.1, 2.5, 2.6)

parameters.Append Object
 

La méthode Append ajoute un nouvel objet Parameter à la classe de collection Parameters actuelle.

Arguments
Object

Le seul paramètre de la méthode Append est un objet Parameter. La propriété Type de l'objet Parameter doit être définie avant que la méthode Append soit effectivement appelée. En outre, si le type de données de l'objet Parameter est de longueur variable, vous devez également fixer la propriété Size de l'objet Parameter à une valeur supérieure à zéro.

 
Description

La méthode Append de la collection Parameters informe ADO du type de paramètres qui figurent dans des procédures stockées ou des requêtes paramétrées. Vous pouvez l'utiliser pour plusieurs raisons : tout d'abord, elle réduit la durée nécessaire pour qu'une procédure stockée ou une requête paramétrée s'exécute, en réduisant au minimum le nombre d'appels du fournisseur de données pour obtenir ces informations. En outre, la déclaration des paramètres à l'avance (en les ajoutant à la collection Paramètres) peut se justifier parce que tous les fournisseurs de données ne communiquent pas toujours ces informations à ADO. Dès lors, si vous ne remplissez pas vous-même la collection Parameters, vous courez un sérieux risque d'être tout à fait incapable d'utiliser ces procédures stockées ou ces requêtes.

Il est conseillé (et Microsoft est également de cet avis) de déclarer autant que possible les paramètres d'une procédure stockée ou d'une requête paramétrée à l'avance, car il ne peut pas toujours être possible de compter que les informations seront disponibles pour ADO (en outre, l'augmentation de vitesse est toujours appréciable).

 
Voir aussi

Méthode Command.CreateParameter, propriété Parameter.Size, propriété Parameter.Type

 
Propriété Parameters.Count (Versions 2.0, 2.1, 2.5, 2.6)

count = parameters.Count
 

La propriété Count indique le nombre d'objets Parameter appartenant à la collection Parameters associé.

Type de données

Long

 
Description

Si la valeur de la propriété Count indique zéro, il n'existe aucun objet Parameter dans la collection Parameters associée. Toutefois, les objets Parameter appartenant à la collection Parameters associé sont indexés de 0 à la valeur de la propriété Count moins un.

 
Méthode Parameters.Delete (Versions 2.0, 2.1, 2.5, 2.6)

parameters.Delete Index
 

La méthode Delete supprime un objet Parameter de la classe de collection Parameters.

Arguments
Index

Le paramètre Index peut être le nom de l'objet Parameter à supprimer ou sa position ordinale.

 
Description

La méthode Delete de la classe de collection Parameters supprime un objet Parameter de la collection. En transmettant le nom d'un objet Parameter valide dans la collection ou sa position ordinale, la méthode Delete supprime l'objet Parameter spécifié de la classe de collection Parameters associée.

 
Voir aussi

Propriété Parameter.Name

 
Propriété Parameters.Item (Versions 2.0, 2.1, 2.5, 2.6)

Set error = errors.Item(Index)
Set error = errors (Index)
 

La propriété Item permet d'accéder à un objet Parameter spécifique appartenant à la collection Parameters.

Type de données

Objet

 
Description

L'espace réservé Index est un type de données variable qui représente la position ordinale d'un objet Parameter dans la collection Parameters. Si la collection Parameters ne contient pas l'élément requis, une erreur est générée.

 
Remarque

Certains langages ne prennent pas en charge la propriété Item dans la première syntaxe. Le cas échéant, utilisez la seconde syntaxe, sans le nom de méthode Item.

 
Méthode Parameters.Refresh (Versions 2.0, 2.1, 2.5, 2.6)

parameters.Refresh
 

La méthode Refresh de la classe de collection Parameters met à jour la collection au moyen des paramètres de la procédure stockée ou de la requête paramétrée actuellement associée à l'objet Command auquel appartient la collection Parameters.

Description

La méthode Refresh actualise la classe de collection Parameters au moyen des paramètres de la procédure stockée ou de la requête paramétrée de l'objet Command associé.

Si vous tentez d'accéder à la classe de collection Parameters avant d'appeler la méthode Refresh, elle est automatiquement appelée par ADO.