IoBrowseInterface Class Reference

#include <iobrowse.h>

Inheritance diagram for IoBrowseInterface:

Detailed Description

The IoBrowserIterator interface for a given Url. This IoBrowserIterator needs to be implemented for each protocol that support kind of directories. (e.g. "file", "zip")

Public Member Functions

const MAXON_METHOD UrlGetBasePath () const
 
MAXON_METHOD Result< void > Reset ()
 
MAXON_METHOD Result< void > GetNext ()
 
MAXON_METHOD Bool HasEntry () const
 
MAXON_METHOD Url GetCurrentPath () const
 
MAXON_METHOD IOBROWSEFLAGS IoGetFlags () const
 
MAXON_METHOD Result< IOATTRIBUTESIoGetAttributes () const
 
MAXON_METHOD Result< UniversalDateTimeIoGetTime (IOTIMEMODE mode) const
 
MAXON_METHOD Int64 GetSize () const
 
MAXON_METHOD String GetExtraData () const
 
 MAXON_ADD_TO_REFERENCE_CLASS (const IoBrowseRef &operator*() { return *(IoBrowseRef *)((char *) this+(S::HAS_ERROR ? SIZEOF(void *) :0));} Result< void > operator++() { return GetNext();} template< typename SUPER > using ResultFunctions=ResultIteratorFunctions< ObjectRef::ResultFunctions< SUPER >>;)
 

Private Member Functions

 MAXON_INTERFACE (IoBrowseInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.iobrowse")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( IoBrowseInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.iobrowse"   
)
private

◆ GetBasePath()

const MAXON_METHOD Url& GetBasePath ( ) const

Returns corresponding Url.

Returns
Name of the connection.

◆ Reset()

MAXON_METHOD Result<void> Reset ( )

Restart browsing of the directory.

Returns
OK on success.

◆ GetNext()

MAXON_METHOD Result<void> GetNext ( )

Browses to the next object in the list. You need to call GetNext() before you get the first object. A typical use is: while (browse->GetNext()) { n = browse->GetCurrentPath(); }

Returns
OK on success.

◆ HasEntry()

MAXON_METHOD Bool HasEntry ( ) const

◆ GetCurrentPath()

MAXON_METHOD Url GetCurrentPath ( ) const

Returns the current Url.

◆ IoGetFlags()

MAXON_METHOD IOBROWSEFLAGS IoGetFlags ( ) const

Returns the flags (IOBROWSEFLAGS) of the children.

◆ IoGetAttributes()

MAXON_METHOD Result<IOATTRIBUTES> IoGetAttributes ( ) const

Returns the flags (IOATTRIBUTES) of the children.

◆ IoGetTime()

MAXON_METHOD Result<UniversalDateTime> IoGetTime ( IOTIMEMODE  mode) const

Returns the DateTime of the current file. The time is in local time.

Parameters
[in]modeIOTIMEMODE of the requested time.
Returns
Returns the DateTime or an error.

◆ GetSize()

MAXON_METHOD Int64 GetSize ( ) const

Returns the size of the current file.

Returns
Size in bytes. -1 means unknown size.

◆ GetExtraData()

MAXON_METHOD String GetExtraData ( ) const

Returns some extra data.

Returns
The return value depends on the handler what it returns. URLSCHEME_VOLUME: returns the human readable drive name.

◆ MAXON_ADD_TO_REFERENCE_CLASS()

MAXON_ADD_TO_REFERENCE_CLASS ( const IoBrowseRef &operator*() { return *(IoBrowseRef *)((char *) this+(S::HAS_ERROR ? SIZEOF(void *) :0));} Result< void > operator++() { return GetNext();} template< typename SUPER > using  ResultFunctions = ResultIteratorFunctions< ObjectRef::ResultFunctions< SUPER >>;)