OfxMessageSuiteV1 Struct Reference

#include <ofxMessage.h>

List of all members.

---

Detailed Description

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

Public Attributes
OfxStatus(*	message )(void *handle, const char *messageType, const char *messageId, const char *format,...)
	Post a message on the host, using printf style varargs.

---

Member Data Documentation

OfxStatus(* OfxMessageSuiteV1::message)(void *handle, const char *messageType, const char *messageId, const char *format,...)

Post a message on the host, using printf style varargs. handle - effect handle (descriptor or instance) the message should be associated with, may be null messageType - string describing the kind of message to post, one of the kOfxMessageType* constants messageId - plugin specified id to associate with this message. If overriding the message in XML resource, the message is identified with this, this may be NULL, or "", in which case no override will occur, format - printf style format string ... - printf style varargs list to print Returns: kOfxStatOK - if the message was sucessfully posted kOfxStatReplyYes - if the message was of type kOfxMessageQuestion and the user reply yes kOfxStatReplyNo - if the message was of type kOfxMessageQuestion and the user reply no kOfxStatFailed - if the message could not be posted for some reason

---

The documentation for this struct was generated from the following file:

• ofxMessage.h

---

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.