IRootCatalog Class Reference

Provides access to members that managing the root catalog. More...

#include <gdb_catalog.h>

Inheritance diagram for IRootCatalog:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetCatalog (CatalogType type, ICatalog **catalog) const =0 throw ()
	Returns one of the other catalogs specified by type. More...
virtual GDBResult SDK_CALLTYPE	CreateCatalog (CatalogType type, ICatalogEdit **catalog)=0 throw ()
	Creates a new catalog. More...
virtual GDBResult SDK_CALLTYPE	GetGeodatabaseProperty (RootCatalogGeodatabaseProperty property_id, SDKAny &property_value)=0 throw ()
	Returns a geodatabase property. More...
virtual GDBResult SDK_CALLTYPE	GetResourceStorage (base::ISDKResourceStorage **resource_storage) const =0 throw ()
	Returns a geodatabase resource storage. More...
Public Member Functions inherited from ICatalog
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 that managing the root catalog.

Member Function Documentation

GetCatalog()

virtual GDBResult SDK_CALLTYPE GetCatalog ( CatalogType  type, ICatalog **  catalog  ) const throw ( )

pure virtual

Returns one of the other catalogs specified by type.

Parameters

[in]	type	The type of a catalog.
[out]	catalog	Address of a variable that receives a pointer to the ICatalog interface.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotExist

CreateCatalog()

virtual GDBResult SDK_CALLTYPE CreateCatalog ( CatalogType  type, ICatalogEdit **  catalog  ) throw ( )

pure virtual

Creates a new catalog.

Parameters

[in]	type	The type of a catalog.
[in]	catalog	A pointer to the catalog instance.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_Failed

GetGeodatabaseProperty()

virtual GDBResult SDK_CALLTYPE GetGeodatabaseProperty ( RootCatalogGeodatabaseProperty  property_id, SDKAny &  property_value  ) throw ( )

pure virtual

Returns a geodatabase property.

Parameters

[in]	property_id	Geodatabase property identifier.
[out]	property_value	Address of a variable that receives the geodatabase property.

Returns

kSDKResult_Succeeded

kSDKResult_NotExist Returns if a geodatabase does not have the property specified by property_id.

GetResourceStorage()

virtual GDBResult SDK_CALLTYPE GetResourceStorage ( base::ISDKResourceStorage **  resource_storage ) const throw ( )

pure virtual

Returns a geodatabase resource storage.

Parameters

[out]

resource_storage

Address of a variable that receives the base::ISDKResourceStorage.

Returns

kSDKResult_Succeeded

kSDKResult_NotExist

---

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

• gdb_catalog.h