VariablesCollection.ToString Method
Returns a delimited string that represents the contents of the collection.
Namespace: Microsoft.SqlServer.Dts.Tasks.Exec80PackageTask
Assembly: Microsoft.SqlServer.Exec80PackageTask (in Microsoft.SqlServer.Exec80PackageTask.dll)
Syntax
'Declaration
Public Overrides Function ToString As String
'Usage
Dim instance As VariablesCollection
Dim returnValue As String
returnValue = instance.ToString()
public override string ToString()
public:
virtual String^ ToString() override
abstract ToString : unit -> string
override ToString : unit -> string
public override function ToString() : String
Return Value
Type: System.String
A delimited string that contains the contents of the collection.
Remarks
The string returned by this method can be used in the LoadFromString method to load an entire collection of variables with a single method call.
The delimited string uses the following syntax:
return::= variable;variable;...
variable::=name,datatype,value
The name argument contains the name of the PkgVariable to be added.
The datatype argument contains the data type of the PkgVariable to be added.
The value argument contains the value of the PkgVariable to be added.
Literal comma (,) or semicolon (;) characters included as part of any argument must be prefaced with a backslash (\) character.
Note
String variables that end in the backslash character have a single space character appended to them during the conversion process, to prevent the possibility that the semicolon used to terminate a variable could be misinterpreted as a literal semicolon character by the LoadFromString method.