yocto_messagebox.h File Reference

#include "yocto_api.h"

Include dependency graph for yocto_messagebox.h:

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

Go to the source code of this file.

Classes
class	YMessageBox
class	YSms

Macros
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_PDURECEIVED_INVALID   (YAPI_INVALID_UINT)
#define	Y_PDUSENT_INVALID   (YAPI_INVALID_UINT)
#define	Y_SLOTSBITMAP_INVALID   (YAPI_INVALID_STRING)
#define	Y_SLOTSCOUNT_INVALID   (YAPI_INVALID_UINT)
#define	Y_SLOTSINUSE_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YMessageBoxValueCallback) (YMessageBox *func, const string &functionValue)

Functions
YMessageBox *	yFindMessageBox (const string &func)
YMessageBox *	yFirstMessageBox (void)

Macro Definition Documentation

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 58 of file yocto_messagebox.h.

#define Y_PDURECEIVED_INVALID   (YAPI_INVALID_UINT)

Definition at line 57 of file yocto_messagebox.h.

#define Y_PDUSENT_INVALID   (YAPI_INVALID_UINT)

Definition at line 56 of file yocto_messagebox.h.

#define Y_SLOTSBITMAP_INVALID   (YAPI_INVALID_STRING)

Definition at line 55 of file yocto_messagebox.h.

#define Y_SLOTSCOUNT_INVALID   (YAPI_INVALID_UINT)

Definition at line 54 of file yocto_messagebox.h.

#define Y_SLOTSINUSE_INVALID   (YAPI_INVALID_UINT)

Definition at line 53 of file yocto_messagebox.h.

Typedef Documentation

typedef void(* YMessageBoxValueCallback) (YMessageBox *func, const string &functionValue)

Definition at line 52 of file yocto_messagebox.h.

Function Documentation

YMessageBox* yFindMessageBox ( const string &  func )

inline

Retrieves a MessageBox interface 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 MessageBox interface is online at the time it is invoked. The returned object is nevertheless valid. Use the method YMessageBox.isOnline() to test if the MessageBox interface is indeed online at a given time. In case of ambiguity when looking for a MessageBox interface 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 MessageBox interface

Returns

a YMessageBox object allowing you to drive the MessageBox interface.

Definition at line 549 of file yocto_messagebox.h.

YMessageBox* yFirstMessageBox ( void  )

inline

Starts the enumeration of MessageBox interfaces currently accessible. Use the method YMessageBox.nextMessageBox() to iterate on next MessageBox interfaces.

Returns

a pointer to a YMessageBox object, corresponding to the first MessageBox interface currently online, or a NULL pointer if there are none.

Definition at line 560 of file yocto_messagebox.h.