[][src]Type Definition lv2_sys::LV2_State_Retrieve_Function

type LV2_State_Retrieve_Function = Option<unsafe extern "C" fn(handle: LV2_State_Handle, key: u32, size: *mut usize, type_: *mut u32, flags: *mut u32) -> *const c_void>;

A host-provided function to retrieve a property. @param handle Must be the handle passed to LV2_State_Interface.restore(). @param key The key of the property to retrieve (URID). @param size (Output) If non-NULL, set to the size of the restored value. @param type (Output) If non-NULL, set to the type of the restored value. @param flags (Output) If non-NULL, set to the flags for the restored value. @return A pointer to the restored value (object), or NULL if no value has been stored under key.

A callback of this type is passed by the host to LV2_State_Interface.restore(). This callback is called repeatedly by the plugin to retrieve any properties it requires to restore its state.

The returned value MUST remain valid until LV2_State_Interface.restore() returns. The plugin MUST NOT attempt to use this function, or any value returned from it, outside of the LV2_State_Interface.restore() context.