OfxMessageSuiteV1

Struct OfxMessageSuiteV1 

Source
#[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>, }
Expand description

@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§

Source§

impl Clone for OfxMessageSuiteV1

Source§

fn clone(&self) -> OfxMessageSuiteV1

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OfxMessageSuiteV1

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for OfxMessageSuiteV1

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.