Struct ofx_sys::OfxMessageSuiteV1

#[repr(C)]
pub struct OfxMessageSuiteV1 {
    pub message: Option<unsafe extern "C" fn(handle: *mut c_void, messageType: *const c_char, messageId: *const c_char, format: *const c_char, ...) -> OfxStatus>,
}

@brief 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.

Fields

message: Option<unsafe extern "C" fn(handle: *mut c_void, messageType: *const c_char, messageId: *const c_char, format: *const c_char, ...) -> OfxStatus>

@brief Post a message on the host, using printf style varargs

\arg handle - effect handle (descriptor or instance) the message should be associated with, may be null \arg messageType - string describing the kind of message to post, one of the kOfxMessageType* constants \arg 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, \arg format - printf style format string \arg ... - 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

Trait Implementations

impl Clone for OfxMessageSuiteV1

fn clone(&self) -> OfxMessageSuiteV1

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for OfxMessageSuiteV1

impl Debug for OfxMessageSuiteV1

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.