IBConnectorInfo Collection Methods
In this section, we discuss the IBConnectorInfo collection methods. The methods are discussed in alphabetical order.
Syntax
AddConnectorProperties(Name, Value, Type)
Description
Use the AddConnectorProperties method to add a set of connector properties to a connector.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specify the name of the property as a string. |
| Value |
Specify the value of the property as a string. |
| Type |
Specify the type of the property as a string. The valid values are: |
|
Constant Value |
Description |
|---|---|
|
%Property |
Add a property type property. |
|
%Header |
Add a header type property. |
Returns
A Boolean value: true if the connector properties are added successfully, false otherwise.
Example
The following are examples of typical name/value pairs.
&b1 = &MSG.IBInfo.IBConnectorInfo.AddConnectorProperties("URL", "http://finance.yahoo.com/d/quotes.txt/?symbols=PSFT&format=l1c1d1t1", %Property);
&b2 = &MSG.IBInfo.IBConnectorInfo.AddConnectorProperties("sendUncompressed", "Y", %Header);
&b3 = &MSG.IBInfo.IBConnectorInfo.AddConnectorProperties("FilePath", "C:\Temp", %Property);The following example demonstrates setting a passive connection for the FTP target connector:
&b4 = &MSG.IBInfo.IBConnectorInfo.AddConnectorProperties ("FTPMODE", "PASSIVE", %Property);
Syntax
AddQueryStringArg(Name, Value)
Description
Use the AddQueryStringArg method to add query string arguments to the outbound request. The query string arguments are used by the HTTP connector to step parameters in the URL.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specify the name of the query string argument as a string. |
| Value |
Specify the value for the query string argument as a string. |
Returns
A Boolean value: true if the query string argument is added successfully, false otherwise.
Syntax
ClearConnectorProperties()
Description
Use the ClearConnectorProperties method to clear all the properties in a connector before setting them.
Parameters
None.
Returns
None.
Syntax
ClearQueryStringArgs()
Description
Use the ClearQueryStringArgs method to clear all of the existing query string arguments.
Use the DeleteQueryStringArg method if you want to remove a specific query string argument.
Parameters
None.
Returns
None.
Syntax
DeleteConectorProperties(Name)
Description
Use the DeleteConnectorProperties to delete a specific connector property.
Use the ClearConnectorProperties method to remove all the properties.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specify the name of the connector property you want to delete. |
Returns
A Boolean value: true if the property is deleted successfully, false otherwise.
Syntax
DeleteQueryStringArg(Name)
Description
Use the DeleteQueryStringArg method to delete a specific query string argument.
Use the ClearQueryStringArg method to delete all of the query string arguments.
Parameters
|
Field or Control |
Definition |
|---|---|
| Name |
Specify the name of the query string argument that you want to delete. |
Returns
A Boolean value: true if the query string argument is deleted successfully, false otherwise.
Syntax
GetConnectorPropertiesName(Index)
Description
Use the GetConnectorPropertiesName to return the name of the connector property in the numeric position specified by Index.
Parameters
|
Field or Control |
Definition |
|---|---|
| Index |
Specify the numeric position of the connector property name that you want to access. |
Returns
A string containing the name of a connector property.
Example
For &I = 1 to &Msg.IBInfo.IBConnectorInfo.GetNumberOfConnectorProperties();
&PropName = &Msg.IBInfo.IBConnectorInfo.GetConnectorPropertiesName(&I)
/* do processing */
End-For;Syntax
GetConnectorPropertiesType(Index)
Description
Use the GetConnectorPropertiesType method to return the type of the connector property specified by its numeric position by Index.
Parameters
|
Field or Control |
Definition |
|---|---|
| Index |
Specify the numeric position of the connector property type that you want to access. |
Returns
A string containing the type of the specified connector.
Syntax
GetConnectorPropertiesValue(Index)
Description
Use the GetConnectorPropertiesValue method to return the value of the connector property specified by its numeric position by Index.
Parameters
|
Field or Control |
Definition |
|---|---|
| Index |
Specify the numeric position of the connector property type that you want to access. |
Returns
A string containing the value of the specified connector.
Syntax
GetNumberOfConnectorProperties()
Description
Use the GetNumberOfConnectorProperties method to determine the number of connector properties.
Parameters
None.
Returns
A number.
Syntax
GetNumberOfQueryStringArgs()
Description
Use the GetNumberOfQueryStringArgs method to determine the number of query string arguments.
Parameters
None.
Returns
A number.
Syntax
GetQueryStringArgName(Index)
Description
Use the GetQueryStringArgName method to access the name of the query string argument by its numeric position as specified by Index.
Parameters
|
Field or Control |
Definition |
|---|---|
| Index |
Specify the numeric position of the query string argument name that you want to access. |
Returns
A string containing the name of a query string argument.
Syntax
GetQueryStringArgValue(Index)
Description
Use the GetQueryStringArgValue method to access the value of the query string argument by its numeric posistion as specified by Index.
Parameters
|
Field or Control |
Definition |
|---|---|
| Index |
Specify the numeric position of the query string argument value that you want to access. |
Returns
A string containing the value of a query string argument.