yocto_files.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_files.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YFileRecord
class	YFiles

Macros
#define	Y_FILESCOUNT_INVALID   (YAPI_INVALID_UINT)
#define	Y_FREESPACE_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YFilesValueCallback) (YFiles *func, const string &functionValue)

Functions
YFiles *	yFindFiles (const string &func)
YFiles *	yFirstFiles (void)

Macro Definition Documentation

#define Y_FILESCOUNT_INVALID   (YAPI_INVALID_UINT)

Definition at line 53 of file yocto_files.h.

#define Y_FREESPACE_INVALID   (YAPI_INVALID_UINT)

Definition at line 54 of file yocto_files.h.

Typedef Documentation

typedef void(* YFilesValueCallback) (YFiles *func, const string &functionValue)

Definition at line 52 of file yocto_files.h.

Function Documentation

YFiles* yFindFiles ( const string &  func )

inline

Retrieves a filesystem for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the filesystem is online at the time it is invoked. The returned object is nevertheless valid. Use the method YFiles.isOnline() to test if the filesystem is indeed online at a given time. In case of ambiguity when looking for a filesystem by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the filesystem

Returns

a YFiles object allowing you to drive the filesystem.

Definition at line 355 of file yocto_files.h.

YFiles* yFirstFiles ( void  )

inline

Starts the enumeration of filesystems currently accessible. Use the method YFiles.nextFiles() to iterate on next filesystems.

Returns

a pointer to a YFiles object, corresponding to the first filesystem currently online, or a NULL pointer if there are none.

Definition at line 366 of file yocto_files.h.