Classe ParameterBase

  • Artigo

The ParameterBase class is a base class that is inherited by the Parameter class and the UserDefinedAggregate class. It contains common features of both classes.

Hierarquia de herança

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.UserDefinedAggregateParameter

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

Sintaxe

'Declaração
Public Class ParameterBase _
    Inherits ScriptNameObjectBase _
    Implements IExtendedProperties, IMarkForDrop
'Uso
Dim instance As ParameterBase

public class ParameterBase : ScriptNameObjectBase, 
    IExtendedProperties, IMarkForDrop

public ref class ParameterBase : public ScriptNameObjectBase, 
    IExtendedProperties, IMarkForDrop

type ParameterBase =  
    class 
        inherit ScriptNameObjectBase 
        interface IExtendedProperties 
        interface IMarkForDrop 
    end

public class ParameterBase extends ScriptNameObjectBase implements IExtendedProperties, IMarkForDrop

O tipo ParameterBase expõe os membros a seguir.

Propriedades

  Nome Descrição
Propriedade pública DataType Gets or sets the data type associated with the parameter.
Propriedade protegida ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Herdado de SqlSmoObject.)
Propriedade pública ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the ParameterBase object.
Propriedade protegida IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Herdado de SqlSmoObject.)
Propriedade pública Name Gets or sets a String value that specifies the name of the parameter. (Substitui NamedSmoObject.Name.)
Propriedade 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. (Herdado de SqlSmoObject.)
Propriedade pública Properties Gets a collection of Property objects that represent the object properties. (Herdado de SqlSmoObject.)
Propriedade protegida ScalarResult Gets the scalar result for the referenced object. (Herdado de SqlSmoObject.)
Propriedade pública State Gets the state of the referenced object. (Herdado de SmoObjectBase.)
Propriedade pública Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Herdado de SqlSmoObject.)
Propriedade pública UserData Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.)

Início

Métodos

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

Início

Eventos

  Nome Descrição
Evento público PropertyChanged Represents the event that occurs when a property is changed. (Herdado de SqlSmoObject.)
Evento público PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Herdado de SqlSmoObject.)

Início

Campos

  Nome Descrição
Campo protegido m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Herdado de SqlSmoObject.)
Campo protegido singletonParent Represents the singleton parent. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetDomainRoot Returns the root of the domain. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetParent Gets the parent of this object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyType Gets the type of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações 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. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Herdado de SqlSmoObject.)

Início

Comentários

Thread Safety

Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads.

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo