DataCommand.DeriveParameters Method (String)
Derives the parameters that can be specified for a given command.
Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)
Syntax
'Declaration
Public Function DeriveParameters ( _
command As String _
) As IVsDataParameter()
public IVsDataParameter[] DeriveParameters(
string command
)
public:
virtual array<IVsDataParameter^>^ DeriveParameters(
String^ command
) sealed
abstract DeriveParameters :
command:string -> IVsDataParameter[]
override DeriveParameters :
command:string -> IVsDataParameter[]
public final function DeriveParameters(
command : String
) : IVsDataParameter[]
Parameters
command
Type: System.StringA command from which to derive parameters specific to a data source.
Return Value
Type: array<Microsoft.VisualStudio.Data.Services.SupportEntities.IVsDataParameter[]
An array of IVsDataParameter objects. Each object represents a parameter that is derived from the command.
Implements
IVsDataCommand.DeriveParameters(String)
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | The command parameter is nulla null reference (Nothing in Visual Basic). |
Remarks
After the instances of the derived parameter objects are retrieved, the client owns them and can modify their values as needed. The client will then pass these values along with a command type set to Text and an appropriate time-out value to the Execute or the [M:Microsoft.VisualStudio.Data.Framework.DataCommand.ExecuteWithoutResults(System.String,T:Microsoft.VisualStudio.Data.Services.SupportEntities.DataCommandType,Microsoft.VisualStudio.Data.Framework.DataParameter[],System.Int32)] method.
Note
Other exceptions that occur indicate that the parameter derivation failed for a provider-specified reason.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.