Коллекция Parameters (ADO)Parameters Collection (ADO)

Содержит все объекты параметров объекта Command .Contains all the Parameter objects of a Command object.

RemarksRemarks

Объект Command содержит коллекцию Parameters , состоящие из объектов параметров .A Command object has a Parameters collection made up of Parameter objects.

При использовании метода Refresh в коллекции Parameters объекта Command извлекаются сведения о параметрах поставщика для хранимой процедуры или параметризованного запроса, указанного в объекте Command .Using the Refresh method on a Command object's Parameters collection retrieves provider parameter information for the stored procedure or parameterized query specified in the Command object. Некоторые поставщики не поддерживают вызовы хранимых процедур или параметризованные запросы; вызов метода Refresh для коллекции Parameters при использовании такого поставщика возвратит ошибку.Some providers do not support stored procedure calls or parameterized queries; calling the Refresh method on the Parameters collection when using such a provider will return an error.

Если вы не определили собственные объекты параметров и хотите получить доступ к коллекции Parameters перед вызовом метода Refresh , ADO автоматически вызовет метод и заполнит коллекцию.If you have not defined your own Parameter objects and you access the Parameters collection before calling the Refresh method, ADO will automatically call the method and populate the collection for you.

Можно уменьшить число вызовов поставщика, чтобы повысить производительность, если известно, какие свойства параметров связаны с хранимой процедурой или параметризованным запросом, который необходимо вызвать.You can minimize calls to the provider to improve performance if you know the properties of the parameters associated with the stored procedure or parameterized query you wish to call. Используйте метод CreateParameter для создания объектов параметров с соответствующими параметрами свойств и используйте метод append , чтобы добавить их в коллекцию Parameters .Use the CreateParameter method to create Parameter objects with the appropriate property settings and use the Append method to add them to the Parameters collection. Это позволяет задавать и возвращать значения параметров без вызова поставщика для сведений о параметрах.This lets you set and return parameter values without having to call the provider for the parameter information. При записи в поставщик, который не предоставляет сведения о параметрах, необходимо вручную заполнить коллекцию Parameters с помощью этого метода, чтобы иметь возможность использовать параметры вообще.If you are writing to a provider that does not supply parameter information, you must manually populate the Parameters collection using this method to be able to use parameters at all. При необходимости удалите объекты параметров из коллекции Parameters с помощью метода Delete .Use the Delete method to remove Parameter objects from the Parameters collection if necessary.

Объекты в коллекции Parameters набора записей выходят за пределы области действия (поэтому становятся недоступными) при закрытии набора записей .The objects in the Parameters collection of a Recordset go out of scope (therefore becoming unavailable) when the Recordset is closed.

При вызове хранимой процедуры с командойвозвращаемое значение или выходной параметр хранимой процедуры извлекается следующим образом:When calling a stored procedure with Command, the return value/output parameter of a stored procedure is retrieved as follows:

  1. При вызове хранимой процедуры, не имеющей параметров, метод Refresh коллекции Parameters должен вызываться перед вызовом метода EXECUTE для объекта Command .When calling a stored procedure that has no parameters, the Refresh method on the Parameters collection should be called before calling the Execute method on the Command object.

  2. При вызове хранимой процедуры с параметрами и явном добавлении параметра в коллекцию Parameters с добавлениемвозвращаемого значения или выходного параметра в коллекцию Parameters следует добавить.When calling a stored procedure with parameters and explicitly appending a parameter to the Parameters collection with Append, the return value/output parameter should be appended to the Parameters collection. Возвращаемое значение должно сначала быть добавлено в коллекцию Parameters .The return value must first be appended to the Parameters collection. Используйте append , чтобы добавить другие параметры в коллекцию Parameters в порядке определения.Use Append to add the other parameters into the Parameters collection in the order of definition. Например, хранимая процедура Спвиспарам имеет два параметра.For example, the stored procedure SPWithParam has two parameters. Первый параметр, param, — это входной параметр, определенный как адварчар (20), а второй параметр, param, — это выходной параметр, определенный как адварчар (20).The first parameter, InParam, is an input parameter defined as adVarChar (20), and the second parameter, OutParam, is an output parameter defined as adVarChar (20). Возвращаемое значение и выходной параметр можно получить с помощью следующего кода.You can retrieve the return value/output parameter with the following code.

    ' Open Connection Conn  
    set ccmd = CreateObject("ADODB.Command")  
    ccmd.Activeconnection= Conn  
    
    ccmd.CommandText="SPWithParam"  
    ccmd.commandType = 4 'adCmdStoredProc  
    
    ccmd.parameters.Append ccmd.CreateParameter(, adInteger, adParamReturnValue, , NULL)   ' return value  
    ccmd.parameters.Append ccmd.CreateParameter("InParam", adVarChar, adParamInput, 20, "hello world")   ' input parameter  
    ccmd.parameters.Append ccmd.CreateParameter("OutParam", adVarChar, adParamOutput, 20, NULL)   ' output parameter  
    
    ccmd.execute()  
    
    ' Access ccmd.parameters(0) as return value of this stored procedure  
    ' Access ccmd.parameters("OutParam") as the output parameter of this stored procedure.  
    
    
  3. При вызове хранимой процедуры с параметрами и настройке параметров путем вызова метода Item для коллекции Parameters возвращаемое значение или выходной параметр хранимой процедуры можно получить из коллекции Parameters .When calling a stored procedure with parameters and configuring the parameters by calling the Item method on the Parameters collection, the return value/output parameter of the stored procedure can be retrieved from the Parameters collection. Например, хранимая процедура Спвиспарам имеет два параметра.For example, the stored procedure SPWithParam has two parameters. Первый параметр, param, — это входной параметр, определенный как адварчар (20), а второй параметр, param, — это выходной параметр, определенный как адварчар (20).The first parameter, InParam, is an input parameter defined as adVarChar (20), and the second parameter, OutParam, is an output parameter defined as adVarChar (20). Возвращаемое значение и выходной параметр можно получить с помощью следующего кода.You can retrieve the return value/output parameter with the following code.

    ' Open Connection Conn  
    set ccmd = CreateObject("ADODB.Command")  
    ccmd.Activeconnection= Conn  
    
    ccmd.CommandText="SPWithParam"  
    ccmd.commandType = 4 'adCmdStoredProc  
    
    ccmd.parameters.Item("InParam").value = "hello world" ' input parameter  
    ccmd.execute()  
    
    ' Access ccmd.parameters(0) as return value of stored procedure  
    ' Access ccmd.parameters(2) or ccmd.parameters("OutParam") as the output parameter.  
    

Этот раздел содержит следующий раздел.This section contains the following topic.

См. такжеSee Also

Метод Append (ADO) Append Method (ADO)
Метод CreateParameter (ADO) CreateParameter Method (ADO)
Объект ParameterParameter Object