CONNX Data Integration Suite 14.8.0 | Developer Guide | CONNX .NET Data Provider | CONNX .NET Data Provider Object Model | CNXParameterCollection
 
CNXParameterCollection
Namespace:
System.Data.CONNX
Description:
The CNXParameterCollection is used for holding the parameters for a given CNXCommand object.
Properties:
Count
Return Type:
Int
Description:
The Count property returns the number of CNXParameter objects in the collection.
Methods:
Add
Return Type:
Int
Description:
The Add method adds the specified object to the collection. The return value is an Int value representing the index of the item in the collection.
Parameters:
Value
Type:
Object
Description:
Object to be added to the collection.
Add
Return Type:
Int
Description:
The Add method adds the specified CNXParameter object to the collection. The return value is an Int value representing the index of the item in the collection.
Parameters:
Value
Type:
CNXParameter
Description:
CNXParameter object to be added to the collection.
Add
Return Type:
Int
Description:
The Add methods adds a new CNXParameter object to the collection with the specified parameterName and value. The return value is an Int value representing the index of the new CNXParameter object in the collection.
Parameters:
ParameterName
Type:
String
Description:
Name of the parameter.
Value
Type:
Object
Description:
Object containing the data for the new parameter.
Add
Return Type:
Int
Description:
The Add method adds a new CNXParameter object to the collection with the specified ParameterName and value. The return value is an Int value representing the index of the new CNXParameter object in the collection.
Parameters:
ParameterName
Type:
String
Description:
Name of parameter.
dbType
Type:
CNXDbType
Description:
CONNX data type for the parameter.
SourceColumn
Type:
String
Description:
Name of the target column for the parameter.
Add
Return Type:
Int
Description:
The Add method adds a new CNXParameter object to the collection with the specified ParameterName and value. The return value is an Int value representing the index of the new CNXParameter object in the collection.
Parameters:
ParameterName
Type:
String
Description:
Name of the parameter.
DbType
Type:
CNXDbType
Description:
CONNX data type for the parameter.
Length
Type:
Int
Description:
Object that contains the data for the parameter.
Add
Return Type:
Int
Description:
The Add method adds a new CNXParameter object to the collection with the specified ParameterName and value. the return value is an Int value representing the index of the new CNXParameter object in the collection.
Parameters:
ParameterName
Type:
String
Description:
Name of the parameter.
DbType
Type:
CNXDbType
Description:
CONNX data type for the parameter.
Length
Type:
Int
Description:
Length of the parameter.
SourceColumn
Type:
String
Description:
Name of the target column for the parameter.
CNXParameter
Return Type:
Void
Description:
The Clear method removes all of the items from the collection.
Parameters:
None
Contains
Return Type:
Bool
Description:
The Contains method returns a Boolean value based on whether the specified parameter name exists in the collection.
Parameters:
ParameterName
Type:
String
Description:
Name of parameters to find.
Contains
Return Type:
Bool
Description:
The Contains method returns a Boolean value denoting whether the specified object is contained in the collection.
Parameters:
Value
Type:
Object
Description:
Object to search for.
CopyTo
Return Type:
Void
Description:
The CopyTo method enables users to copy elements of the collection to a specified array.
Parameters:
Array
Type:
Array
Description:
Destination for the copied elements.
Index
Type:
Int
Description:
Starting position in the array.
GetEnumerator
Return Type:
IEnumerator
Description:
The GetEnumerator method returns an IEnumerator interface that is used to iterate through the items in the collection.
Parameters:
None
IndexOf
Return Type:
Int
Description:
The IndexOf method returns an Int value representing the index of the parameter specified by the parameter name.
Parameters:
ParameterName
Type:
String
Description:
Name of the parameter for which to retrieve an index.
IndexOf
Return Type:
Int
Description:
The IndexOf method is used to retrieve the index of the specified object.
Parameters:
Value
Type:
Object
Description:
Object for which the index is retrieved.
Insert
Return Type:
Void
Description:
The Insert method enables users to insert an object into the collection at the specified index.
Parameters:
Index
Type:
Int
Description:
Index at which to insert the object.
Value
Type:
Object
Description:
Object to be inserted.
Remove
Return Type:
Byte
Description:
The Precision property is used to specify the number of decimal places to retain for the given parameter.
Parameters:
Value
Type:
Object
Description:
Object to be removed from the collection.
RemoveAt
Return Type:
Byte
Description:
The RemoveAt method removes the parameter specified by the parameter name.
Parameters:
ParameterName
Type:
String
Description:
Name of the parameter to be removed.
RemoveAt
Return Type:
Int
Description:
The RemoveAt method removes the parameter at the specified index.
Parameters:
I
Type:
Int
Description:
Index of parameter to be removed.