ICatalog Class Reference

Provides access to members for reading a Catalog. A Catalog is a collection of entries that specifies a catalog content. More...

#include <gdb_catalog.h>

Inheritance diagram for ICatalog:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetCatalogEntries (CatalogEntryType type, IEnumCatalogEntry **entries) const =0 throw ()
	Returns an enumerator over the entries in the catalog for the specified entry type. More...
virtual GDBResult SDK_CALLTYPE	GetCatalogEntry (const CatalogEntryKey *entry_key, ICatalogEntry **entry) const =0 throw ()
	Returns a catalog entry specified by the entry identifier. For example, the entry_key can be a Dataset name or an entry index. More...
virtual GDBResult SDK_CALLTYPE	GetCatalogProperty (CatalogPropertyID id, SDKAny *property) const =0 throw ()
	Returns the value of the specified property. More...
virtual GDBResult SDK_CALLTYPE	GetCatalogEntryCount (SDKUInt32 &count) const =0 throw ()
	Returns the number of catalog entries. More...
Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE	AddRef () const =0 throw ()
	Increments the reference count for an interface on a component.
virtual SDKAtomicRefCount SDK_CALLTYPE	Release () const =0 throw ()
	Decrements the reference count for an interface on a component.
virtual SDKResult SDK_CALLTYPE	GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
	Returns pointers to the supported interfaces on a component.
template<typename _Itf >
SDKResult	GetInterface (_Itf **obj_ptr) throw ()
	Returns pointers to the supported interfaces on a component.

Detailed Description

Provides access to members for reading a Catalog. A Catalog is a collection of entries that specifies a catalog content.

Member Function Documentation

GetCatalogEntries()

virtual GDBResult SDK_CALLTYPE GetCatalogEntries ( CatalogEntryType  type, IEnumCatalogEntry **  entries  ) const throw ( )

pure virtual

Returns an enumerator over the entries in the catalog for the specified entry type.

Parameters

type	[in] The type of requested entries.
entries	[out] Address of variable that receives a pointer to the IEnumCatalogEntry interface.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_Failed

GetCatalogEntry()

virtual GDBResult SDK_CALLTYPE GetCatalogEntry ( const CatalogEntryKey *  entry_key, ICatalogEntry **  entry  ) const throw ( )

pure virtual

Returns a catalog entry specified by the entry identifier. For example, the entry_key can be a Dataset name or an entry index.

Parameters

entry_key	[in] An entry identifier.
entry	[out] Address of a variable that receives a pointer to the ICatalogEntry.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotExist

GetCatalogProperty()

virtual GDBResult SDK_CALLTYPE GetCatalogProperty ( CatalogPropertyID  id, SDKAny *  property  ) const throw ( )

pure virtual

Returns the value of the specified property.

Parameters

id	[in] An identifier of the catalog property.
property	[out] Pointer to the SDKAny variable that receives a property.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotExist

GetCatalogEntryCount()

virtual GDBResult SDK_CALLTYPE GetCatalogEntryCount ( SDKUInt32 &  count ) const throw ( )

pure virtual

Returns the number of catalog entries.

Parameters

[out]

count

Address of a variable that receives the number of catalog entries

Returns

kSDKResult_Succeeded

---

The documentation for this class was generated from the following file:

• gdb_catalog.h