Compartir a través de


Clase Parameter

The Parameter class represents a parameter. It is a base class that is inherited by the StoredProcedureParameter class and the UserDefinedFunctionParameter class and contains common features of both classes.

Jerarquía de herencia

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.NumberedStoredProcedureParameter
              Microsoft.SqlServer.Management.Smo.StoredProcedureParameter
              Microsoft.SqlServer.Management.Smo.UserDefinedFunctionParameter

Espacio de nombres:  Microsoft.SqlServer.Management.Smo
Ensamblado:  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Sintaxis

'Declaración
Public Class Parameter _
    Inherits ParameterBase _
    Implements ISfcSupportsDesignMode
'Uso
Dim instance As Parameter
public class Parameter : ParameterBase, ISfcSupportsDesignMode
public ref class Parameter : public ParameterBase, 
    ISfcSupportsDesignMode
type Parameter =  
    class 
        inherit ParameterBase 
        interface ISfcSupportsDesignMode 
    end
public class Parameter extends ParameterBase implements ISfcSupportsDesignMode

El tipo Parameter expone los siguientes miembros.

Constructores

  Nombre Descripción
Método protegido Parameter Initializes a new instance of the Parameter class.

Arriba

Propiedades

  Nombre Descripción
Propiedad pública DataType Gets or sets the data type associated with the parameter. (Se hereda de ParameterBase.)
Propiedad pública DefaultValue Gets or sets the default value of the parameter.
Propiedad protegida ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Se hereda de SqlSmoObject.)
Propiedad pública ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the ParameterBase object. (Se hereda de ParameterBase.)
Propiedad pública ID Gets the ID value that uniquely identifies the parameter.
Propiedad pública IsReadOnly Gets or sets whether the parameter is read only.
Propiedad protegida IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Se hereda de SqlSmoObject.)
Propiedad pública Name Gets or sets a String value that specifies the name of the parameter. (Se hereda de ParameterBase.)
Propiedad protegida ObjectInSpace Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Se hereda de SqlSmoObject.)
Propiedad pública Properties Gets a collection of Property objects that represent the object properties. (Se hereda de SqlSmoObject.)
Propiedad protegida ScalarResult Gets the scalar result for the referenced object. (Se hereda de SqlSmoObject.)
Propiedad pública State Gets the state of the referenced object. (Se hereda de SmoObjectBase.)
Propiedad pública Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Se hereda de SqlSmoObject.)
Propiedad pública UserData Gets or sets user-defined data associated with the referenced object. (Se hereda de SmoObjectBase.)

Arriba

Métodos

  Nombre Descripción
Método protegido AddDatabaseContext Add the database context to the collection of queries identified by the queries parameter. (Se hereda de SqlSmoObject.)
Método protegido AlterImpl Activates the object altered event. (Se hereda de SqlSmoObject.)
Método protegido AlterImplWorker Calls the Alter methods. (Se hereda de SqlSmoObject.)
Método protegido AppendCommaText Appends text, optionally separated by a comma. (Se hereda de ScriptNameObjectBase.)
Método protegido AppendWithCommaText Appends text, optionally separated by a comma. (Se hereda de ScriptNameObjectBase.)
Método protegido AppendWithOption Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Se hereda de ScriptNameObjectBase.)
Método protegido AutoGenerateName Generates a name based on the object Guid. (Se hereda de ScriptNameObjectBase.)
Método protegido BindDefaultImpl Binds the default items identified by the parameters. (Se hereda de SqlSmoObject.)
Método protegido BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Se hereda de SqlSmoObject.)
Método protegido CheckObjectDirty Checks whether object has been modified and not persisted. (Se hereda de ScriptNameObjectBase.)
Método protegido CheckObjectState() Validates the state of the referenced object. (Se hereda de SqlSmoObject.)
Método protegido CheckObjectState(Boolean) Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Se hereda de SqlSmoObject.)
Método protegido CheckObjectStateImpl Checks the state of a SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido CheckParamName Checks the parameter name. (Se hereda de ParameterBase.)
Método protegido CheckTextCorectness Checks text for correctness against the parameters. (Se hereda de ScriptNameObjectBase.)
Método protegido CheckTextModeSupport Checks mode of support. (Se hereda de ScriptNameObjectBase.)
Método protegido CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion110() Checks whether version of SQL Server is SQL Server 2012. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion110(String) Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion80 Checks the validity of the object on SQL Server 2000. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion90 Check the validity of the object on SQL Server 2005. (Se hereda de SqlSmoObject.)
Método protegido CheckVersionBelow110 Checks whether version of SQL Server is before SQL Server 2012. (Se hereda de SqlSmoObject.)
Método protegido CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Se hereda de SqlSmoObject.)
Método protegido CleanObject Cleans the referenced object. (Se hereda de ScriptNameObjectBase.)
Método protegido CreateImpl Creates an object with scripting options. (Se hereda de SqlSmoObject.)
Método público Discover Discovers a list of type Object. (Se hereda de SqlSmoObject.)
Método protegido DropImpl Drops a SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido DropImplWorker Calls the drop methods. (Se hereda de SqlSmoObject.)
Método público Equals (Se hereda de Object.)
Método protegido ExecuteNonQuery Executes a batch of statements that does not return a result set. (Se hereda de SqlSmoObject.)
Método protegido ExecuteRenameQuery Executes the rename query for the object. (Se hereda de NamedSmoObject.)
Método protegido Finalize (Se hereda de Object.)
Método protegido ForceTextModeOnTextBody Enforces text mode on the text body. (Se hereda de ScriptNameObjectBase.)
Método protegido FormatSqlVariant Formats an object as SqlVariant type. (Se hereda de SqlSmoObject.)
Método protegido GenerateAlterEvent() Generates the alter event with the specified value. (Se hereda de SqlSmoObject.)
Método protegido GenerateAlterEvent(Urn, Object) Generates alter event with the specified URN and inner object value. (Se hereda de SqlSmoObject.)
Método protegido GetBraketNameForText Gets the bracket name for the text. (Se hereda de ScriptNameObjectBase.)
Método protegido GetContextDB Gets the context database that is associated with this object. (Se hereda de SqlSmoObject.)
Método protegido GetDBName Gets the database name that is associated with the object. (Se hereda de SqlSmoObject.)
Método protegido GetFragOptionString Gets a FragmentationOption object as a string value. (Se hereda de SqlSmoObject.)
Método público GetHashCode (Se hereda de Object.)
Método protegido GetIsSystemNamed Gets a Boolean value that specifies whether the system is named. (Se hereda de ScriptNameObjectBase.)
Método protegido GetIsTextDirty Determines whether the text value is consistent with stored value. (Se hereda de ScriptNameObjectBase.)
Método protegido GetPropValue Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetPropValueOptional Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetRealValue Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetServerName Gets the name of the instance of SQL Server with which the object is associated. (Se hereda de SqlSmoObject.)
Método protegido GetServerObject Gets the server of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (Se hereda de SqlSmoObject.)
Método protegido GetTextBody() Returns the text body. (Se hereda de ScriptNameObjectBase.)
Método protegido GetTextBody(Boolean) Returns the text body. (Se hereda de ScriptNameObjectBase.)
Método protegido GetTextHeader Returns the text header. (Se hereda de ScriptNameObjectBase.)
Método protegido GetTextMode Determines whether the script name is using text mode. (Se hereda de ScriptNameObjectBase.)
Método protegido GetTextProperty Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (Se hereda de ScriptNameObjectBase.)
Método público GetType (Se hereda de Object.)
Método protegido GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido ImplInitialize Initializes the fields of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método público Initialize() Initializes the object and forces the properties be loaded. (Se hereda de SqlSmoObject.)
Método público Initialize(Boolean) Initializes the object and forces the properties be loaded. (Se hereda de SqlSmoObject.)
Método protegido IsObjectDirty Determines whether the referenced object is consistent with the stored object. (Se hereda de ScriptNameObjectBase.)
Método protegido IsObjectInitialized Verifies whether the object has been initialized. (Se hereda de SqlSmoObject.)
Método protegido IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Se hereda de SqlSmoObject.)
Método protegido isParentClrImplemented Gets a Boolean which indicates whether the parent object is implemented in CLR. (Se hereda de ParameterBase.)
Método protegido IsVersion80SP3 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Se hereda de SqlSmoObject.)
Método protegido IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Se hereda de SqlSmoObject.)
Método protegido MarkDropped Sets the SqlSmoState to dropped. (Se hereda de SqlSmoObject.)
Método público MarkForDrop Marks the foreign key to be dropped next time its parent object is altered by the Alter method. (Se hereda de ParameterBase.)
Método protegido MarkForDropImpl Sets the SqlSmoState for drop operation. (Se hereda de SqlSmoObject.)
Método protegido MemberwiseClone (Se hereda de Object.)
Método protegido PostAlter The method that is activated after the SqlSmoObject is altered. (Se hereda de SqlSmoObject.)
Método protegido PostCreate The method that is activated after the SqlSmoObject is created. (Se hereda de SqlSmoObject.)
Método protegido PostDrop The method that is activated after the SqlSmoObject is dropped. (Se hereda de SqlSmoObject.)
Método público Refresh Refreshes the ParameterBase object. (Se hereda de ParameterBase.)
Método protegido RenameImpl This method supports the SMO infrastructure and is not intended to be used directly from your code. (Se hereda de NamedSmoObject.)
Método protegido RenameImplWorker Solamente se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada. (Se hereda de NamedSmoObject.)
Método protegido ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido SetCollectionTextMode Sets the collection text mode. (Se hereda de ScriptNameObjectBase.)
Método protegido SetIsSystemNamed Sets a Boolean value that specifies whether the system is named. (Se hereda de ScriptNameObjectBase.)
Método protegido SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Se hereda de SqlSmoObject.)
Método protegido SetSchemaOwned Sets the schema owned value. (Se hereda de NamedSmoObject.)
Método protegido SetTextBody Specifies the text body. (Se hereda de ScriptNameObjectBase.)
Método protegido SetTextHeader Specifies the text header. (Se hereda de ScriptNameObjectBase.)
Método protegido SetTextMode Specifies the text mode. (Se hereda de ScriptNameObjectBase.)
Método protegido SwitchTextMode Switches the text mode. (Se hereda de ScriptNameObjectBase.)
Método protegido ThrowIfTextIsDirtyForAlter Throws an exception of text has been modified and not persisted. (Se hereda de ScriptNameObjectBase.)
Método público ToString Returns a String that represents the referenced object. (Se hereda de SqlSmoObject.)
Método protegido TouchImpl Not implemented. (Se hereda de SqlSmoObject.)
Método protegido UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido UnbindRuleImpl Unbinds rules of the SqlSmoObject. (Se hereda de SqlSmoObject.)
Método público Validate Validates the state of an object. (Se hereda de SmoObjectBase.)

Arriba

Eventos

  Nombre Descripción
Evento público PropertyChanged Represents the event that occurs when a property is changed. (Se hereda de SqlSmoObject.)
Evento público PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Se hereda de SqlSmoObject.)

Arriba

Campos

  Nombre Descripción
Campo protegido m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Se hereda de SqlSmoObject.)
Campo protegido singletonParent Represents the singleton parent. (Se hereda de SqlSmoObject.)

Arriba

Implementaciones de interfaces explícitas

  Nombre Descripción
Implementación de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetDomainRoot Returns the root of the domain. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetParent Gets the parent of this object. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetPropertyType Gets the type of the specified property. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasPropiedad privada ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode. Solamente se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada.

Arriba

Comentarios

Thread Safety

Todos los miembros estáticos (compartidos en Microsoft Visual Basic) públicos de este tipo son seguros para operaciones multiproceso. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Vea también

Referencia

Espacio de nombres Microsoft.SqlServer.Management.Smo