TuttleOFX  1
Data Fields
OfxMessageSuiteV1 Struct Reference

The OFX suite that allows a plug-in to pass messages back to a user. The V2 suite extends on this in a backwards compatible manner. More...

#include <ofxMessage.h>

Data Fields

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

Detailed Description

The OFX suite that allows a plug-in to pass messages back to a user. The V2 suite extends on this in a backwards compatible manner.

Definition at line 90 of file ofxMessage.h.

Field 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

Definition at line 107 of file ofxMessage.h.

Referenced by OFX::ImageEffect::sendMessage().

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