Struct OfxMessageSuiteV1

struct OfxMessageSuiteV1

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.

Public Members

OfxStatus (*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

Return:

  • kOfxStatOK - if the message was successfully 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