ofxMessage.h File Reference

---

Detailed Description

This file contains the Host API for end user message communication.

#include "ofxCore.h"

Go to the source code of this file.

Classes
struct	OfxMessageSuiteV1
	The OFX suite that allows a plug-in to pass messages back to a user. More...
Defines
#define	kOfxMessageSuite   "OfxMessageSuite"
#define	kOfxMessageFatal   "OfxMessageFatal"
	String used to type fatal error messages.
#define	kOfxMessageError   "OfxMessageError"
	String used to type error messages.
#define	kOfxMessageMessage   "OfxMessageMessage"
	String used to type simple ordinary messages.
#define	kOfxMessageLog   "OfxMessageLog"
	String used to type log messages.
#define	kOfxMessageQuestion   "OfxMessageQuestion"
	String used to type yes/no messages.
Typedefs
typedef OfxMessageSuiteV1	OfxMessageSuiteV1
	The OFX suite that allows a plug-in to pass messages back to a user.

---

Define Documentation

#define kOfxMessageError   "OfxMessageError"

String used to type error messages. Ordinary error messages should be posted when there is an error in operation that is recoverable by user intervention.

#define kOfxMessageFatal   "OfxMessageFatal"

String used to type fatal error messages. Fatal error messages should only be posted by a plugin when it can no longer continue operation.

#define kOfxMessageLog   "OfxMessageLog"

String used to type log messages. Log messages are written out to a log and not to the end user.

#define kOfxMessageMessage   "OfxMessageMessage"

String used to type simple ordinary messages. Ordinary messages simply convey information from the plugin directly to the user.

#define kOfxMessageQuestion   "OfxMessageQuestion"

String used to type yes/no messages. The host is to enter a modal state which waits for the user to respond yes or no. The OfxMessageSuiteV1::message function which posted the message will only return after the user responds. When asking a question, the OfxStatus code returned by the message function will be, kOfxStatReplyYes - if the user replied 'yes' to the question kOfxStatReplyNo - if the user replied 'no' to the question some error code if an error was encounterred It is an error to post a question message if the plugin is not in an interactive session.

#define kOfxMessageSuite   "OfxMessageSuite"

---

Typedef Documentation

typedef struct OfxMessageSuiteV1 OfxMessageSuiteV1

The OFX suite that allows a plug-in to pass messages back to a user.

---

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:

1. Redistributions of the document must retain the above copyright notice and this list of conditions.
2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Automatic documentation generated by DOxygen.