FDO API Reference | Feature Data Objects |
#include <IdentifierCollection.h>
Inherits FdoCollection< FdoIdentifier, FdoCommandException >.
Inheritance diagram for FdoIdentifierCollection:
Definition at line 32 of file IdentifierCollection.h.
Public Member Functions | |
virtual FdoInt32 | Add (FdoIdentifier *value) |
Adds the specified item to the end of the collection. Returns the index of the newly added item. | |
virtual void | Clear () |
Removes all items from the collection. | |
virtual bool | Contains (FdoString *name) |
Returns true if the collection contains the specified item, false otherwise. | |
virtual bool | Contains (const FdoIdentifier *value) |
Returns true if the collection contains the specified item, false otherwise. | |
FDO_API FdoIdentifier * | FindItem (const wchar_t *name) |
Finds the item in the collection with the specified name. | |
FDO_API FdoIdentifier * | GetItem (const wchar_t *name) |
Gets the item in the collection with the specified name. Throws an exception if the item is not found. | |
FDO_API FdoIdentifier * | GetItem (FdoInt32 index) |
Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range. | |
virtual FdoInt32 | IndexOf (FdoString *name) |
Returns the index of the specified item (by name) in the collection or -1 if the item does not exist. | |
virtual FdoInt32 | IndexOf (const FdoIdentifier *value) |
Returns the index of the specified item in the collection or -1 if the item does not exist. | |
virtual void | Insert (FdoInt32 item, FdoIdentifier *value) |
Inserts the specified item at the specified index within the collection. Items following the insertion point are moved down to accommodate the new item. Throws an invalid argument exception if the specified index is out of range. | |
virtual void | Remove (const FdoIdentifier *value) |
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection. | |
virtual void | RemoveAt (FdoInt32 index) |
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection. | |
virtual void | SetItem (FdoInt32 index, FdoIdentifier *value) |
Sets the item in the collection at the specified index to the specified value. Throws an invalid argument exception if the index is out of range. | |
Static Public Member Functions | |
FDO_API FdoIdentifierCollection * | Create () |
Constructs a default empty instance of an FdoIdentifierCollection. | |
Protected Member Functions | |
void | CheckDuplicate (FdoIdentifier *item, FdoInt32 index) |
int | Compare (FdoString *str1, FdoString *str2) const |
DOXYGEN-IGNORE | |
virtual void | Dispose () |
DOXYGEN-IGNORE | |
FdoIdentifierCollection (bool caseSensitive=true) | |
virtual | ~FdoIdentifierCollection (void) |
|
Definition at line 366 of file IdentifierCollection.h. |
|
Definition at line 372 of file IdentifierCollection.h. |
|
Adds the specified item to the end of the collection. Returns the index of the newly added item.
Reimplemented from FdoCollection< FdoIdentifier, FdoCommandException >. Definition at line 175 of file IdentifierCollection.h. References FdoCollection< OBJ, EXC >::Add(), CheckDuplicate(), and FdoInt32. |
Here is the call graph for this function:
|
Definition at line 392 of file IdentifierCollection.h. References FdoCommandException::Create(), FDO_45_ITEMINCOLLECTION, FDO_NLSID, FdoString, FindItem(), GetItem(), FdoIdentifier::GetText(), and FdoPtr< T >::p. |
Here is the call graph for this function:
|
Removes all items from the collection.
Reimplemented from FdoCollection< FdoIdentifier, FdoCommandException >. Definition at line 220 of file IdentifierCollection.h. References FdoCollection< OBJ, EXC >::Clear(). |
Here is the call graph for this function:
|
DOXYGEN-IGNORE
Definition at line 379 of file IdentifierCollection.h. Referenced by Contains(), FindItem(), and IndexOf(). |
|
Returns true if the collection contains the specified item, false otherwise.
Definition at line 315 of file IdentifierCollection.h. References FDO_SAFE_RELEASE, and FindItem(). |
Here is the call graph for this function:
|
Returns true if the collection contains the specified item, false otherwise.
Definition at line 279 of file IdentifierCollection.h. References Compare(), FdoInt32, FdoString, FdoCollection< OBJ, EXC >::GetCount(), GetItem(), and FdoIdentifier::GetText(). |
Here is the call graph for this function:
|
Constructs a default empty instance of an FdoIdentifierCollection.
|
|
DOXYGEN-IGNORE
Implements FdoIDisposable. |
|
Finds the item in the collection with the specified name.
Definition at line 97 of file IdentifierCollection.h. References Compare(), FDO_API, FDO_SAFE_RELEASE, FdoInt32, GetItem(), and FdoIdentifier::GetText(). Referenced by CheckDuplicate(), Contains(), and GetItem(). |
Here is the call graph for this function:
|
Gets the item in the collection with the specified name. Throws an exception if the item is not found.
Definition at line 72 of file IdentifierCollection.h. References FdoCommandException::Create(), FDO_38_ITEMNOTFOUND, FDO_API, FDO_NLSID, and FindItem(). |
Here is the call graph for this function:
|
Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
Definition at line 58 of file IdentifierCollection.h. References FDO_API, and FdoCollection< OBJ, EXC >::GetItem(). Referenced by CheckDuplicate(), Contains(), FindItem(), and IndexOf(). |
Here is the call graph for this function:
|
Returns the index of the specified item (by name) in the collection or -1 if the item does not exist.
Definition at line 348 of file IdentifierCollection.h. References Compare(), FdoCommandException::Create(), FDO_2_BADPARAMETER, FDO_NLSID, FdoInt32, FdoString, FdoCollection< OBJ, EXC >::GetCount(), and GetItem(). |
Here is the call graph for this function:
|
Returns the index of the specified item in the collection or -1 if the item does not exist.
Definition at line 334 of file IdentifierCollection.h. References FdoInt32, and FdoCollection< OBJ, EXC >::IndexOf(). |
Here is the call graph for this function:
|
Inserts the specified item at the specified index within the collection. Items following the insertion point are moved down to accommodate the new item. Throws an invalid argument exception if the specified index is out of range.
Reimplemented from FdoCollection< FdoIdentifier, FdoCommandException >. Definition at line 201 of file IdentifierCollection.h. References CheckDuplicate(), and FdoCollection< OBJ, EXC >::Insert(). |
Here is the call graph for this function:
|
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection.
Reimplemented from FdoCollection< FdoIdentifier, FdoCommandException >. Definition at line 241 of file IdentifierCollection.h. References FdoCollection< OBJ, EXC >::Remove(). |
Here is the call graph for this function:
|
Removes the specified item from the collection. Throws an invalid argument exception if the item does not exist within the collection.
Reimplemented from FdoCollection< FdoIdentifier, FdoCommandException >. Definition at line 260 of file IdentifierCollection.h. References FdoCollection< OBJ, EXC >::RemoveAt(). |
Here is the call graph for this function:
|
Sets the item in the collection at the specified index to the specified value. Throws an invalid argument exception if the index is out of range.
Reimplemented from FdoCollection< FdoIdentifier, FdoCommandException >. Definition at line 150 of file IdentifierCollection.h. References CheckDuplicate(), and FdoCollection< OBJ, EXC >::SetItem(). |
Here is the call graph for this function:
Comments or suggestions? Send us feedback. |