RZDCX - Fast Strike DICOM Toolkit  Release 2.0.8.7
IDCXOBJIterator Interface Reference

This class is used to iterate over a collection of objects. More...

Inherits IDispatch.

Inherited by StorageCommitSCPExample.StorageCommitSCPExampleForm.MyIterator.

Public Member Functions

HRESULT AtEnd ([out, retval] VARIANT_BOOL *atEnd)
 Indicates the end of the collection. More...
 
HRESULT Get ([out, retval] IDCXOBJ **obj)
 Get the current object. More...
 
HRESULT Next ()
 Advances the iterator to the next object.
 
HRESULT Insert ([in] IDCXOBJ *obj)
 Inserts an object into a sequence. More...
 

Detailed Description

This class is used to iterate over a collection of objects.

Sequences of objects are usfull when dealing with sequence data elements - VR_CODE_SQ Another example is an objects collection when performing a DICOM query. In this case each object will hold the data of a single query result.

Iterator.

Examples:
StorageCommitSCPExampleForm.cs.

Member Function Documentation

◆ AtEnd()

HRESULT IDCXOBJIterator::AtEnd ( [out, retval] VARIANT_BOOL *  atEnd)

Indicates the end of the collection.

Returns
false while there are more objects.
Examples:
StorageCommitSCPExampleForm.cs.

◆ Get()

HRESULT IDCXOBJIterator::Get ( [out, retval] IDCXOBJ **  obj)

Get the current object.

Returns
an IDCXOBJ interafce
Examples:
StorageCommitSCPExampleForm.cs.

◆ Insert()

HRESULT IDCXOBJIterator::Insert ( [in] IDCXOBJ obj)

Inserts an object into a sequence.

Use the object iterator The object

Examples:
StorageCommitSCPExampleForm.cs.