NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Public Member Functions
IEnumDatasetID Class Referenceabstract
Data Layer » Workspace

Provides access to members that enumerate through dataset ids. More...

#include <gdb_workspace.h>

Inheritance diagram for IEnumDatasetID:
ISDKComponent

Public Member Functions

virtual GDBResult SDK_CALLTYPE Next (DatasetID *dataset_id) const =0 throw ()
 Retrieves the next dataset id in the enumeration sequence. More...
 
virtual GDBResult SDK_CALLTYPE Reset () const =0 throw ()
 Resets the enumeration sequence to the beginning.
 
- 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 enumerate through dataset ids.

Member Function Documentation

◆ Next()

virtual GDBResult SDK_CALLTYPE Next ( DatasetID *  dataset_id) const
throw (
)
pure virtual

Retrieves the next dataset id in the enumeration sequence.

Parameters
[out]dataset_idPointer to a variable that receives the dataset id.
Returns
kSDKResult_Succeeded
kSDKResult_False Indicates the end of enumeration.
kSDKResult_NotImplemented
The documentation for this class was generated from the following file: