Skip to main content

pamoja_gateway_station_message_text

pamoja_ffi::gateway_station

Function pamoja_gateway_station_message_text 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_gateway_station_message_text(
    message: *const PamojaGatewayStationMessage,
    field: u8,
    out_text: *mut *mut PamojaBuffer,
) -> PamojaStatus
Expand description

Returns a piece of text a message carries.

§Arguments

  • message - the message.
  • field - which text, one of the PAMOJA_GATEWAY_STATION_TEXT_* constants.
  • out_text - receives the text, which the caller releases with pamoja_buffer_free.

§Returns

PamojaStatus::Ok once written, with empty text for a field the kind does not carry, or PamojaStatus::InvalidArgument when field names no text.

§Safety

message must be a live handle, and out_text must point to writable storage.