StoredProcedureParameter Class

  • Article

The StoredProcedureParameter object represents a SQL Server stored procedure parameter.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ParameterBase
            Microsoft.SqlServer.Management.Smo.Parameter
              Microsoft.SqlServer.Management.Smo.StoredProcedureParameter

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcElementTypeAttribute("Param")> _
Public NotInheritable Class StoredProcedureParameter _
    Inherits Parameter _
    Implements ISfcSupportsDesignMode
'Usage
Dim instance As StoredProcedureParameter

[SfcElementTypeAttribute("Param")]
public sealed class StoredProcedureParameter : Parameter, 
    ISfcSupportsDesignMode

[SfcElementTypeAttribute(L"Param")]
public ref class StoredProcedureParameter sealed : public Parameter, 
    ISfcSupportsDesignMode

[<SealedAttribute>]
[<SfcElementTypeAttribute("Param")>]
type StoredProcedureParameter =  
    class 
        inherit Parameter 
        interface ISfcSupportsDesignMode 
    end

public final class StoredProcedureParameter extends Parameter implements ISfcSupportsDesignMode

The StoredProcedureParameter type exposes the following members.

Constructors

  Name Description
Public method StoredProcedureParameter() Initializes a new instance of the StoredProcedureParameter class.
Public method StoredProcedureParameter(StoredProcedure, String) Initializes a new instance of the StoredProcedureParameter class for the specified stored procedure and with the specified name.
Public method StoredProcedureParameter(StoredProcedure, String, DataType) Initializes a new instance of the StoredProcedureParameter class for the specified stored procedure and with the specified name and data type.

Top

Properties

  Name Description
Public property DataType Gets or sets the data type associated with the parameter. (Inherited from ParameterBase.)
Public property DefaultValue Gets or sets the default value of the parameter. (Inherited from Parameter.)
Public property ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the ParameterBase object. (Inherited from ParameterBase.)
Public property ID Gets the ID value that uniquely identifies the parameter. (Inherited from Parameter.)
Public property IsCursorParameter Gets or sets the Boolean property that specifies whether the parameter is a cursor parameter.
Public property IsOutputParameter Gets or sets the Boolean property that specifies whether the parameter is an output parameter.
Public property IsReadOnly Gets or sets whether the parameter is read only. (Inherited from Parameter.)
Public property Name Gets or sets a String value that specifies the name of the parameter. (Inherited from ParameterBase.)
Public property Parent Gets the StoredProcedure object that is the parent of the StoredProcedureParameter object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method MarkForDrop Marks the foreign key to be dropped next time its parent object is altered by the Alter method. (Inherited from ParameterBase.)
Public method Refresh Refreshes the ParameterBase object. (Inherited from ParameterBase.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a value that indicates whether the StoredProcedureParameter object supports design mode.

Top

Remarks

To get StoredProcedureParameter object properties, users can be a member of the public fixed server role.

To set StoredProcedureParameter object properties, users must have ALTER permission on the parent stored procedure, or be a member of db_owner fixed database role.

To create a stored procedure, users must have CREATE PROCEDURE permission on the parent database or be a member of the db_owner fixed database role.

To drop a stored procedure parameter, users must have CONTROL permission on the parent stored procedure or be a member of the db_owner fixed database role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Creating, Altering, and Removing Stored Procedures

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace