IoBrowseInterface Class Reference IO

#include <iobrowse.h>

Inheritance diagram for IoBrowseInterface:

详细描述

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")

公共成员函数

const MAXON_METHOD Url GetBasePath () const
MAXON_METHOD Result < void >  重置 ()
MAXON_METHOD Result < void >  GetNext ()
MAXON_METHOD Bool   HasEntry () const
MAXON_METHOD Url   GetCurrentPath () const
MAXON_METHOD IOBROWSEFLAGS   IoGetFlags () const
MAXON_METHOD Result < IOATTRIBUTES IoGetAttributes () const
MAXON_METHOD Result < UniversalDateTime IoGetTime ( 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 >>;)

私有成员函数

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

成员函数文档编制

◆  MAXON_INTERFACE()

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

◆  GetBasePath()

const MAXON_METHOD Url & GetBasePath ( ) const

Returns corresponding Url .

返回
Name of the connection.

◆  Reset()

MAXON_METHOD Result <void> Reset ( )

Restart browsing of the directory.

返回
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() ; }

返回
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.

参数
[in] mode IOTIMEMODE of the requested time.
返回
Returns the DateTime or an error.

◆  GetSize()

MAXON_METHOD Int64 GetSize ( ) const

Returns the size of the current file.

返回
Size in bytes. -1 means unknown size.

◆  GetExtraData()

MAXON_METHOD String GetExtraData ( ) const

Returns some extra data.

返回
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 >>; )