Partilhar via


Classe Variable

Represents a variable on a package, task, or container. This class cannot be inherited.

Hierarquia de herança

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Variable

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (em Microsoft.SqlServer.ManagedDTS.dll)

Sintaxe

'Declaração
Public NotInheritable Class Variable _
    Inherits DtsObject _
    Implements IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath,  _
    IDTSExecutionPath, IComponent, IDisposable
'Uso
Dim instance As Variable
public sealed class Variable : DtsObject, 
    IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
    IComponent, IDisposable
public ref class Variable sealed : public DtsObject, 
    IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
    IComponent, IDisposable
[<SealedAttribute>]
type Variable =  
    class 
        inherit DtsObject 
        interface IDTSPersist 
        interface IDTSName 
        interface IDTSPropertiesProvider 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
        interface IComponent 
        interface IDisposable 
    end
public final class Variable extends DtsObject implements IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, IComponent, IDisposable

O tipo Variable expõe os membros a seguir.

Propriedades

  Nome Descrição
Propriedade pública CreationName Gets the string that the runtime engine gives when it creates an instance of the Variable object and adds the object to the Variables collection. This property is read-only.
Propriedade pública DataType Gets a TypeCode enumeration that describes the data type of the variable. This property is read-only.
Propriedade pública Description Gets or sets the description for the variable.
Propriedade pública EvaluateAsExpression Gets or sets a Boolean that indicates whether the variable contains an expression.
Propriedade pública Expression Gets or sets the expression contained in a variable.
Propriedade pública ID Gets the GUID assigned to the variable. This field is read-only.
Propriedade pública IncludeInDebugDump Gets or sets a value that specifies whether the variable value for a user-defined variable or a system variable is included in the debug dump files.
Propriedade pública Name Gets or sets the name of the variable.
Propriedade pública Namespace Gets or sets the namespace that the variable belongs to.
Propriedade pública Parent Gets the parent container of the Variable instance.
Propriedade pública Properties Gets a collection of DtsProperty objects. This property is read-only.
Propriedade pública QualifiedName Gets the fully qualified name of the variable, including the namespace. This property is read-only.
Propriedade pública RaiseChangedEvent Gets or sets a Boolean that indicates if the variable has been flagged to raise the OnVariableValueChanged event when the value of the variable changes.
Propriedade pública ReadOnly Gets or sets a Boolean that indicates that the variable is read-only and cannot have its value modified.
Propriedade pública Site Infraestrutura. Gets or sets the site of the variable.
Propriedade pública SystemVariable Gets a Boolean that indicates whether the variable is a system variable. This property is read-only.
Propriedade pública Value Gets or sets the value assigned to the variable.

Início

Métodos

  Nome Descrição
Método público Dispose This method is inherited from the IDisposable.Dispose method, which is a mechanism to explicitly tell an object to perform cleanup.
Método público Equals Determines whether two object instances are equal. (Herdado de DtsObject.)
Método público GetExecutionPath Returns the execution path of the current Variable object.
Método público GetExpression The GetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
Método público GetHashCode Returns the hash code for this instance. (Herdado de DtsObject.)
Método público GetPackagePath Returns the path of the package that the variable belongs to.
Método público GetSensitiveValue Returns the sensitive variable value.
Método público GetType (Herdado de Object.)
Método público LoadFromXML This method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.
Método público SaveToXML This method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.
Método público SetExpression The SetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
Método público ToString (Herdado de Object.)

Início

Eventos

  Nome Descrição
Evento público Disposed Adds an event handler to listen to the Disposed event on the variable.

Início

Comentários

Variables are grouped into namespaces for disambiguation. The System namespace is created automatically for every package and contains read-only properties. The User namespace contains custom properties that you can add. You can also create a namespace of your choosing to which to add variables. This class inherits from several classes and interfaces, including two from the Visual Studio .NET Framework:

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.Dts.Runtime