OfxMessageSuiteV2

struct OfxMessageSuiteV2

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

This extends OfxMessageSuiteV1, and should be considered a replacement to version 1.

Note that this suite has been extended in backwards compatible manner, so that a host can return this struct for both V1 and V2.

Public Members

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

Post a transient message on the host, using printf style varargs. Same as the V1 message suite call.

  • 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 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

OfxStatus (*setPersistentMessage)(void *handle, const char *messageType, const char *messageId, const char *format, ...)

Post a persistent message on an effect, using printf style varargs, and set error states. New for V2 message suite.

  • handle - effect instance handle the message should be associated with, may NOT be null,
  • messageType - string describing the kind of message to post, should be one of…
    • kOfxMessageError
    • kOfxMessageWarning
    • kOfxMessageMessage
  • 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
Persistent messages are associated with an effect handle until explicitly cleared by an effect. So if an error message is posted the error state, and associated message will persist and be displayed on the effect appropriately. (eg: draw a node in red on a node based compostor and display the message when clicked on).
Return

If messageType is error or warning, associated error states should be flagged on host applications. Posting an error message implies that the host cannot proceeed, a warning allows the host to proceed, whilst a simple message should have no stop anything.

OfxStatus (*clearPersistentMessage)(void *handle)

Clears any persistent message on an effect handle that was set by OfxMessageSuiteV2::setPersistentMessage. New for V2 message suite.

  • handle - effect instance handle messages should be cleared from.
  • handle - effect handle (descriptor or instance)
Clearing a message will clear any associated error state.
Return