Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
os_mgmt_info_append Struct Reference

#include <os_mgmt.h>

Data Fields

uint32_tformat_bitmask
 The format bitmask from the processed commands, the bits should be cleared once processed, note that if all_format_specified is specified, the corresponding bits here will not be set.
 
bool all_format_specified
 Will be true if the all 'a' specifier was provided.
 
uint8_toutput
 The output buffer which the responses should be appended to.
 
uint16_toutput_length
 The current size of the output response in the output buffer, must be updated to be the size of the output response after appending data.
 
uint16_t buffer_size
 The size of the output buffer, including null terminator character, if the output response would exceed this size, the function must abort and return false to return a memory error to the client.
 
boolprior_output
 

Field Documentation

◆ all_format_specified

bool os_mgmt_info_append::all_format_specified

Will be true if the all 'a' specifier was provided.

◆ buffer_size

uint16_t os_mgmt_info_append::buffer_size

The size of the output buffer, including null terminator character, if the output response would exceed this size, the function must abort and return false to return a memory error to the client.

◆ format_bitmask

uint32_t* os_mgmt_info_append::format_bitmask

The format bitmask from the processed commands, the bits should be cleared once processed, note that if all_format_specified is specified, the corresponding bits here will not be set.

◆ output

uint8_t* os_mgmt_info_append::output

The output buffer which the responses should be appended to.

If prior_output is true, a space must be added prior to the output response

◆ output_length

uint16_t* os_mgmt_info_append::output_length

The current size of the output response in the output buffer, must be updated to be the size of the output response after appending data.

◆ prior_output

bool* os_mgmt_info_append::prior_output

The documentation for this struct was generated from the following file: