maxon.IoBrowseInterface

Description

The IoBrowseIterator interface for a given maxon.Url.

This IoBrowseIterator needs to be implemented for each protocol that support kind of directories (e.g. “file”, “zip”).

Inheritance diagram

Inheritance

Parent Class:

• maxon.ObjectInterface

Child Class:

• maxon.IoBrowseRef

Methods Signature

GetBasePath()	Returns corresponding maxon.Url.
GetCurrentPath()	Returns the current maxon.Url.
GetExtraData()	Returns some extra data.
GetNext()	Browses to the next object in the list.
GetSize()	Returns the size of the current file.
HasEntry()	Checks if there is any entry left
Init(connection, flags)	Private
IoGetAttributes()	Returns the flags (maxon.IOATTRIBUTES) of the children.
IoGetFlags()	Returns the flags (maxon.IOBROWSEFLAGS) of the children.
Reset()	Restart browsing of the directory.

Methods Definition

IoBrowseInterface.GetBasePath()

Returns corresponding maxon.Url.

Returns:Name of the connection. Return type:maxon.Url

IoBrowseInterface.GetCurrentPath()

Returns the current maxon.Url.

Returns:The current maxon.Url. Return type:maxon.Url

IoBrowseInterface.GetExtraData()

Returns some extra data.

Note

maxon.URLSCHEME_VOLUME returns the human readable drive name.

Returns:The return value depends on the handler what it returns. Return type:str

IoBrowseInterface.GetNext()

Browses to the next object in the list. You need to call GetNext() before you get the first object.

IoBrowseInterface.GetSize()

Returns the size of the current file.

Returns:Size in bytes. -1 means unknown size. Return type:int

IoBrowseInterface.HasEntry()

Checks if there is any entry left

Returns:True if the iterator still get content to iterate. Return type:bool

IoBrowseInterface.Init(connection, flags)

Private

Parameters:

• connection (maxon.IoConnectionRef) – maxon.IoConnectionRef Connected to this maxon.IoBrowseRef.
• flags (maxon.GETBROWSEITERATORFLAGS) – Defines how the iterator should behave.

IoBrowseInterface.IoGetAttributes()

Returns the flags (maxon.IOATTRIBUTES) of the children.

Returns:The children flags. Return type:maxon.IOATTRIBUTES

IoBrowseInterface.IoGetFlags()

Returns the flags (maxon.IOBROWSEFLAGS) of the children.

Returns:The children flags. Return type:maxon.IOBROWSEFLAGS

IoBrowseInterface.Reset()

Restart browsing of the directory.