[][src]Function dqcsim::bindings::dqcs_arb_pop_raw

#[no_mangle]pub extern "C" fn dqcs_arb_pop_raw(
    arb: dqcs_handle_t,
    obj: *mut c_void,
    obj_size: size_t
) -> ssize_t

Pops an unstructured raw argument from the back of the list.

If the actual size of the object differs from the specified object size, this function will copy the minimum of the actual and specified sizes number of bytes, and return what the actual size was.

If the specified object size is zero, obj is allowed to be NULL. You can use this if you don't need the contents of the argument and just want to delete it.

Since this function removes the returned element, data will be lost if the specified size is smaller than the actual size. To avoid this, first use dqcs_arb_get_size(handle, -1) to query the size.

This function returns -1 on failure. If this is due to a NULL buffer being passed, the data that was popped is lost.