nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches

◆ bt_mesh_prop_cli_client_props_get()

int bt_mesh_prop_cli_client_props_get ( struct bt_mesh_prop_cli cli,
struct bt_mesh_msg_ctx *  ctx,
uint16_t  id,
struct bt_mesh_prop_list rsp 
)

#include <include/bluetooth/mesh/gen_prop_cli.h>

Get the list of Generic Client Properties of the bound server.

To get the list of other property states, use :ref:bt_mesh_prop_cli_props_get.

This call is blocking if the rsp buffer is non-NULL. Otherwise, this function will return, and the response will be passed to the bt_mesh_prop_cli::prop_list callback.

Parameters
[in]cliClient model to send on.
[in]ctxMessage context, or NULL to use the configured publish parameters.
[in]idA starting Client Property ID present within an element.
[out]rspResponse buffer, or NULL to keep from blocking.
Return values
0Successfully sent the message and populated the rsp buffer.
-EINVALThe rsp::ids list was NULL.
-ENOBUFSThe client received a response, but the supplied response buffer was too small to hold all the properties. All property IDs that could fit in the response buffers were copied into it, and the rsp::count field was left unchanged.
-EALREADYA blocking request is already in progress.
-ENOTSUPA message context was not provided and publishing is not supported.
-EADDRNOTAVAILA message context was not provided and publishing is not configured.
-EAGAINThe device has not been provisioned.
-ETIMEDOUTThe request timed out without a response.