ConnectMacroData Property (IConnectionSettingsCommon)

In This Topic

Gets or specifies a string that passes information to a connect macro. When the connect macro runs, the value of MacroData is set equal to the value of ConnectMacroData.

Syntax

Visual Basic
C#

'Declaration
 
Property ConnectMacroData As String

'Usage
 
Dim instance As IConnectionSettingsCommon
Dim value As String
 
instance.ConnectMacroData = value
 
value = instance.ConnectMacroData

string ConnectMacroData {get; set;}

Property Value

The default value is "". This string can be up to 260 characters long. This value can be changed during an open connection.

Exceptions

Exception	Description
System.ArgumentException	This exception is thrown if the set parameter is longer than the maximum allowed.

Remarks

The value of the MacroData property changes whenever you pass macro data to a macro. (If you run a macro using the Macros dialog box, macro data is specified in the Macro data box. If you run a macro using the RunMacro method, macro data is specified with the second argument.) The ConnectMacroData property stores a fixed value that sets the value of MacroData whenever your connect macro runs.

Reference

IConnectionSettingsCommon Interface
IConnectionSettingsCommon Members

Send Feedback