Nonstop Database, HiRDB Version 9 UAP Development Guide
![[Contents]](FIGURE/CONTENT.GIF)
![[Index]](FIGURE/INDEX.GIF)
![[Back]](FIGURE/FRONT.GIF)
![[Next]](FIGURE/AFTER.GIF)
(1) Constructor
(a) HiRDBParameterCollection
void HiRDBParameterCollection ()
- Description: Initializes a new instance of the HiRDBParameterCollection class.
(2) Properties
- Type: int
- Default value: 0
- Description: Acquires the number of HiRDBParameter objects stored in HiRDBParameterCollection (read only).
(b) IsFixedSize
- Type: bool
- Default value: false
- Description: Acquires a value indicating whether the size of HiRDBParameterCollection is fixed (read only). The value is always false.
(c) IsReadOnly
Type: bool
Default value: false
Description: Acquires a value indicating whether or not HiRDBParameterCollection is read only (read only). The value is always false.
(d) IsSynchronized
- Type: bool
- Default value: false
- Description: Acquires a value indicating whether or not an access to HiRDBParameterCollection is synchronized (thread-safe) (read only). The value is always false.
- Item[int]
- Type: HiRDBParameter this[int index]
- Description: Acquires the HiRDBParameter object for a specified index or sets the HiRDBParameter object in a specified index.
- Item[string]
- Type: HiRDBParameter this[string parameterName]
- Description: Acquires the HiRDBParameter object that has the parameter name specified in the argument, or sets a new HiRDBParameter object in the index of the HiRDBParameter object that has the parameter name specified in the argument.
(f) SyncRoot
- Type: object
- Default value: null
- Description: Acquires an object that can be used to synchronize an access to HiRDBParameterCollection (read only).
(3) Methods
- int Add (object)
- Argument
- object value: HiRDBParameter object to be added to HiRDBParameterCollection
- Return
- int: Index in the new HiRDBParameter object's collection
- Description: Adds items to HiRDBParameterCollection.
- int Add (Hitachi.HiRDB.HiRDBParameter)
- Argument
- HiRDBParameter value: HiRDBParameter to be added to HiRDBParameterCollection
- Return
- int: Index of the new HiRDBParameter
- Description: Adds items to HiRDBParameterCollection.
- int Add (string, object)
- Arguments
- string parameterName: Parameter name
- object parameterValue: Parameter value
- Return
- int: Index of the new HiRDBParameter
- Description: Specifies the name and value of the parameter to add items to HiRDBParameterCollection.
- int Add (string, HiRDBType)
- Arguments
- string parameterName: Parameter name
- HiRDBType dataType: One of the HiRDBType values
- Return
- int: Index of the new HiRDBParameter
- Description: Specifies the name and data type of the parameter to add items to HiRDBParameterCollection.
- int Add (string, HiRDBType, int)
- Arguments
- string parameterName: Parameter name
- HiRDBType dataType: One of the HiRDBType values
- int size: Parameter size
- Return
- int: Index of the new HiRDBParameter
- Description: Specifies the name, data type, and size of the parameter to add items to HiRDBParameterCollection.
- int Add (string, HiRDBType, int, string)
- Arguments
- string parameterName: Parameter name
- HiRDBType dataType: One of the HiRDBType values
- int size: Parameter size
- string srcColumn: Name of the source column
- Return
- int: Index of the new HiRDBParameter
- Description: Specifies the name, data type, size, and source column of the parameter to add items to HiRDBParameterCollection.
(b) AddRange
- void AddRange(Array)
- Argument
- values: Array in the HiRDBParameter object to be added to HiRDBParameterCollection
- Return: void
- Description: Adds an array in the specified HiRDBParameter object to HiRDBParameterCollection.
- Exception: HiRDBException
- void AddRange(HiRDBParameter[])
- Argument
- value: Array in the HiRDBParameter object to be added to HiRDBParameterCollection
- Return: void
- Description: Adds an array in the specified HiRDBParameter object to HiRDBParameterCollection.
- Exception: HiRDBException
void Clear ()
- Return: void
- Description: Deletes all items from HiRDBParameterCollection.
(d) Contains
- bool Contains (object)
- Argument
- object value: Object that is searched for in HiRDBParameterCollection
- Return
- bool: If Object is in HiRDBParameterCollection, the value is true; if not, the value is false.
- Description: Acquires a value indicating whether or not HiRDBParameter is in the collection.
- Exception: HiRDBException
- bool Contains (HiRDBParameter)
- Argument
- HiRDBParameter value: HiRDBParameter object to be searched for in HiRDBParameterCollection
- Return
- bool: If Object is in HiRDBParameterCollection, the value is true; if not, the value is false.
- Description: Acquires a value indicating whether HiRDBParameter is in the collection.
- Exception: HiRDBException
- bool Contains (string)
- Argument
- string parameterName: Parameter name
- Return
- bool: If the parameter is stored in the collection, the value is true; if not, the value is false.
- Description: Acquires a value indicating whether or not HiRDBParameter is in the collection.
- Exception: HiRDBException
(e) CopyTo
void CopyTo (System.Array, int)
- Arguments
- System.Array array: One-dimensional Array to which elements are copied from HiRDBParameterCollection
- int index: Index number, beginning at 0, at the location where value is inserted
- Return: void
- Description: Copies the elements of HiRDBParameterCollection to Array using Array's specific index as the start position.
(f) GetEnumerator
System.Collections.IEnumerator GetEnumerator ()
- Return
- System.Collections.Ienumerator: IEnumerator that can be used to perform iteration processing on a collection
- Description: Returns the enumerator that can perform iterative operation on a collection.
(g) IndexOf: overload
- int IndexOf (string)
- Argument
- string parameterName: Parameter name
- Return
- int: Location of HiRDBParameterCollection in the collection that begins at 0
- Description: Acquires the location of HiRDBParameter in a collection.
- Exception: HiRDBException
- int IndexOf (object)
- Argument
- object value: Object that is searched for in HiRDBParameterCollection
- Return
- int: If the object is in the list, the value is the index of value; if not, the value is -1.
- Description: Acquires the location of HiRDBParameter in a collection.
(h) Insert
- void Insert(int, object)
- Arguments
- int index: Index number, beginning at 0, at the location where value is inserted
- object value: HiRDBParameter to be added to HiRDBParameterCollection
- Return: void
- Description: Inserts an item at the specified location in HiRDBParameterCollection.
- Exception: HiRDBException
- void Insert (int, Hitachi.HiRDB.HiRDBParameter)
- Arguments
- int index: Index number, which begins at 0, at the location where value is inserted
- HiRDBParameter value: HiRDBParameter to be added to HiRDBParameterCollection
- Return: void
- Description: Inserts an item at the specified location in HiRDBParameterCollection.
- Exception: HiRDBException
(i) Remove
void Remove (object)
- Argument
- object value: HiRDBParameter to be deleted from HiRDBParameterCollection
- Return: void
- Description: Deletes the first occurrence of the specified object in HiRDBParameterCollection.
(j) RemoveAt
- void RemoveAt (string)
- Argument
- string parameterName: Parameter name
- Return: void
- Description: Deletes HiRDBParameter from a collection.
- Exception: HiRDBException
- void RemoveAt (int)
- Argument
- int index: Index of the item to be deleted that begins at 0
- Return: void
- Description: Deletes HiRDBParameter from a collection.
All Rights Reserved. Copyright (C) 2011, Hitachi, Ltd.