Skip to main content

pamoja_lora_plan_relay_channel

Function pamoja_lora_plan_relay_channel 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_lora_plan_relay_channel( plan: *const PamojaLoraPlan, index: u8, out_channel: *mut PamojaLoraRelayChannel, ) -> PamojaStatus
Expand description

Returns one of the plan’s default relay channels, RP002-1.0.5 sections 3.4.9 to 3.13.9.

§Arguments

  • plan - the plan to read.
  • index - the channel index a relay configuration names, below the count pamoja_lora_plan_relay_channel_count reports.
  • out_channel - set to the channel on success.

§Returns

PamojaStatus::Ok on success.

§Errors

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

§Safety

plan must be a live plan handle and out_channel must point at writable storage for one PamojaLoraRelayChannel.