Skip to main content

pamoja_mavlink_schema_field

pamoja_ffi::mavlink_schema

Function pamoja_mavlink_schema_field 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_mavlink_schema_field(
    schema: *const PamojaMavlinkSchema,
    index: usize,
    out_field: *mut PamojaMavlinkFieldInfo,
) -> PamojaStatus
Expand description

Describes one field of a message.

§Arguments

  • schema - the shape to read.
  • index - the field position, in wire order, below pamoja_mavlink_schema_field_count.
  • out_field - set to the field’s description on success.

§Returns

PamojaStatus::Ok on success.

§Errors

Returns PamojaStatus::InvalidArgument if either pointer is null or index is past the end of the field list.

§Safety

schema must be a live schema handle, and out_field must point at writable storage for one PamojaMavlinkFieldInfo.