Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.OnlineTitleFileInterface

This interface provides accessors to the platform specific tile file downloading

Engine.OnlineTitleFileInterface

Delegates Summary
delegate OnReadTitleFileComplete (bool bWasSuccessful, tring FileName)

Functions Summary
function AddReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)
functionbool ClearDownloadedFile (string FileName)
functionbool ClearDownloadedFiles ()
function ClearReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate)
functionbool GetTitleFileContents (string FileName, ut array<byte> FileContents)
functionEOnlineEnumerationReadState GetTitleFileState (string FileName)
functionbool ReadTitleFile (string FileToRead)


Delegates Detail

OnReadTitleFileComplete Source code

delegate OnReadTitleFileComplete ( bool bWasSuccessful,string FileName )
Delegate fired when a file read from the network platform's title specific storage is complete
@param bWasSuccessful whether the file read was successful or not
@param FileName the name of the file this was for


Functions Detail

AddReadTitleFileCompleteDelegate Source code

function AddReadTitleFileCompleteDelegate ( delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate )
Adds the delegate to the list to be notified when a requested file has been read
@param ReadTitleFileCompleteDelegate the delegate to add

ClearDownloadedFile Source code

function bool ClearDownloadedFile ( string FileName )
Empties the cached data for this file if it is not being downloaded currently
@param FileName the name of the file to remove from the cache
@return true if it could be deleted, false if it could not

ClearDownloadedFiles Source code

function bool ClearDownloadedFiles ( )
Empties the set of downloaded files if possible (no async tasks outstanding)
@return true if they could be deleted, false if they could not

ClearReadTitleFileCompleteDelegate Source code

function ClearReadTitleFileCompleteDelegate ( delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate )
Removes the delegate from the notify list
@param ReadTitleFileCompleteDelegate the delegate to remove

GetTitleFileContents Source code

function bool GetTitleFileContents ( string FileName,out array<byte> FileContents )
Copies the file data into the specified buffer for the specified file
@param FileName the name of the file to read
@param FileContents the out buffer to copy the data into
@return true if the data was copied, false otherwise

GetTitleFileState Source code

function EOnlineEnumerationReadState GetTitleFileState ( string FileName )
Determines the async state of the tile file read operation
@param FileName the name of the file to check on
@return the async state of the file read

ReadTitleFile Source code

function bool ReadTitleFile ( string FileToRead )
Starts an asynchronous read of the specified file from the network platform's title specific file store
@param FileToRead the name of the file to read
@return true if the calls starts successfully, false otherwise



Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:53.992 - Created with UnCodeX