IDbStoredProcedureManager.GetStoredProcedureParameters Method

Article
2012-05-02

Returns a collection of parameters for a stored procedure.

Namespace: Microsoft.Web.Management.DatabaseManager
Assembly: Microsoft.Web.Management.DatabaseManager (in Microsoft.Web.Management.DatabaseManager.dll)

Syntax

'Declaration
Function GetStoredProcedureParameters ( _
    connectionString As String, _
    schema As String, _
    storedProcedureName As String _
) As ICollection(Of StoredProcedureParameter)
'Usage
Dim instance As IDbStoredProcedureManager
Dim connectionString As String
Dim schema As String
Dim storedProcedureName As String
Dim returnValue As ICollection(Of StoredProcedureParameter)

returnValue = instance.GetStoredProcedureParameters(connectionString, _
    schema, storedProcedureName)

ICollection<StoredProcedureParameter> GetStoredProcedureParameters(
    string connectionString,
    string schema,
    string storedProcedureName
)

ICollection<StoredProcedureParameter^>^ GetStoredProcedureParameters(
    String^ connectionString, 
    String^ schema, 
    String^ storedProcedureName
)

function GetStoredProcedureParameters(
    connectionString : String, 
    schema : String, 
    storedProcedureName : String
) : ICollection<StoredProcedureParameter>

Parameters

connectionString
Type: System.String
The connection string for the database.

schema
Type: System.String
The schema name for the stored procedure.
Note If schema is empty, the default schema name will be used.

storedProcedureName
Type: System.String
The name of the stored procedure.

Return Value

Type: System.Collections.Generic.ICollection<StoredProcedureParameter>
An ICollection object that contains the list of StoredProcedureParameter objects.

Remarks

All database providers that implement the IDbStoredProcedureManager interface must also implement the GetStoredProcedureParameters method. This method returns a collection of StoredProcedureParameter objects for a specific stored procedure that the database manager will use to provide the list of parameters for the various stored procedure methods in your provider.

Notes for Implementers

If your provider does not support retrieving stored procedures, you can use the following code sample to raise a not-implemented exception:

public ICollection<StoredProcedureParameter> GetStoredProcedureParameters(string connectionString, string schema, string storedProcedureName)

{

throw new NotImplementedException();

}

Permissions

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.

Share via