ajustes

Este módulo incluye la plataforma de abstracción para el almacenamiento no volátil de configuración.

Resumen

funciones
`otPlatSettingsAdd ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Añade un valor a un ajuste.
`otPlatSettingsDeinit ( otInstance *aInstance)`	`void` Realiza cualquier de-inicialización de los ajustes subsistema, si es necesario.
`otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex)`	`otError` Elimina una configuración de la tienda de ajuste.
`otPlatSettingsGet ( otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` Obtiene el valor de un ajuste.
`otPlatSettingsInit ( otInstance *aInstance)`	`void` Realiza cualquier inicialización para el subsistema de configuración, si es necesario.
`otPlatSettingsSet ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` Establece o reemplaza el valor de un ajuste.
`otPlatSettingsWipe ( otInstance *aInstance)`	`void` Elimina todos los ajustes de configuración de la tienda.

funciones

otPlatSettingsAdd

 otError otPlatSettingsAdd(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Añade un valor a un ajuste.

Esta función añade el valor de un ajuste identificado por tecla a, sin necesidad de sustituir los valores existentes.

Tenga en cuenta que la implementación subyacente no es necesaria para mantener el orden de los elementos asociados con una tecla específica. El valor añadido se puede añadir al final, al principio, o incluso en algún punto intermedio. El orden de los valores pre-existentes también puede cambiar.

Llamar a esta función con éxito puede hacer que los ajustes no relacionados con múltiples valores a ser reordenadas.

detalles

parámetros

`[in] aInstance`	La estructura de ejemplo OpenThread.
`[in] aKey`	La clave asociada con el ajuste al cambio.
`[in] aValue`	Un puntero a donde el nuevo valor del ajuste debe leerse a partir. No debe ser nulo si aValueLength no es cero.
`[in] aValueLength`	La longitud de los datos a la que apunta unValor. Puede ser cero.

Valores devueltos

`OT_ERROR_NONE`	Se añadió el entorno determinado o por etapas que se añade.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.
`OT_ERROR_NO_BUFS`	No hay espacio restante para almacenar el ajuste dado.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Realiza cualquier de-inicialización de los ajustes subsistema, si es necesario.

detalles

parámetros

[in] aInstance

La estructura de ejemplo OpenThread.

otPlatSettingsDelete

 otError otPlatSettingsDelete(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex
)

Elimina una configuración de la tienda de ajuste.

Esta función borra un valor específico de la configuración identificado por AKey de la tienda de configuración.

Tenga en cuenta que la implementación subyacente no es necesaria para mantener el orden de los elementos asociados con una tecla específica.

detalles

parámetros

`[in] aInstance`	La estructura de ejemplo OpenThread.
`[in] aKey`	La clave asociada con el ajuste solicitado.
`[in] aIndex`	El índice del valor a ser eliminado. Si se establece en -1, se eliminarán todos los valores de este Akey.

Valores devueltos

`OT_ERROR_NONE`	La clave y el índice dado que se encontró y eliminado correctamente.
`OT_ERROR_NOT_FOUND`	El índice o clave dada no se ha encontrado en la tienda de ajuste.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.

otPlatSettingsGet

 otError otPlatSettingsGet(
  otInstance *aInstance,
  uint16_t aKey,
  int aIndex,
  uint8_t *aValue,
  uint16_t *aValueLength
)

Obtiene el valor de un ajuste.

Esta función lee el valor del ajuste identificado por AKey y escribir a la memoria a la que apunta unValor. A continuación, escribe la longitud al número entero apuntado por aValueLength. El valor inicial de aValueLength es el número máximo de bytes que deben escribirse en unValor.

Esta función se puede utilizar para comprobar la existencia de una clave sin recuperar ni el valor mediante el establecimiento de unValor y aValueLength a NULL. También puede comprobar la longitud del ajuste sin ir a buscar mediante el establecimiento de unValor solamente a NULL.

Tenga en cuenta que la aplicación de almacenamiento subyacente no está obligado a mantener el orden de los entornos con múltiples valores. El orden de estos valores pueden cambiar después de cualquier operación de escritura en la tienda.

detalles

parámetros

`[in] aInstance`	La estructura de ejemplo OpenThread.
`[in] aKey`	La clave asociada con el ajuste solicitado.
`[in] aIndex`	El índice del elemento específico de conseguir.
`[out] aValue`	Un puntero a donde el valor del ajuste debe ser escrito. Se puede establecer en NULL si haciendo una prueba para detectar la presencia o la longitud de un ajuste.
`[in,out] aValueLength`	Un puntero a la longitud del valor. Cuando se llama, este puntero debe apuntar a un número entero que contiene el tamaño máximo valor que puede ser escrita a unValor. En cambio, la longitud real de la configuración está escrito. Esto se puede establecer en NULL si se realiza una comprobación de presencia.

Valores devueltos

`OT_ERROR_NONE`	El ajuste dado se encontró y se fue a buscar con éxito.
`OT_ERROR_NOT_FOUND`	El entorno determinado no se encontró en el almacén de configuración.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Realiza cualquier inicialización para el subsistema de configuración, si es necesario.

detalles

parámetros

[in] aInstance

La estructura de ejemplo OpenThread.

otPlatSettingsSet

 otError otPlatSettingsSet(
  otInstance *aInstance,
  uint16_t aKey,
  const uint8_t *aValue,
  uint16_t aValueLength
)

Establece o reemplaza el valor de un ajuste.

Esta función establece o sustituye el valor de un ajuste identificado por AKey. Si había más de un valor previamente asociado con la Tecla A, a continuación, todos ellos están borrados y sustituidos con esta sola entrada.

Llamar a esta función con éxito puede hacer que los ajustes no relacionados con múltiples valores a ser reordenadas.

detalles

parámetros

`[in] aInstance`	La estructura de ejemplo OpenThread.
`[in] aKey`	La clave asociada con el ajuste al cambio.
`[in] aValue`	Un puntero a donde el nuevo valor del ajuste debe leerse a partir. No debe ser nulo si aValueLength no es cero.
`[in] aValueLength`	La longitud de los datos a la que apunta unValor. Puede ser cero.

Valores devueltos

`OT_ERROR_NONE`	El ajuste dado ha sido cambiado o puesta en escena.
`OT_ERROR_NOT_IMPLEMENTED`	Esta función no está implementada en esta plataforma.
`OT_ERROR_NO_BUFS`	No hay espacio restante para almacenar el ajuste dado.

otPlatSettingsWipe

void otPlatSettingsWipe(
  otInstance *aInstance
)

Elimina todos los ajustes de configuración de la tienda.

Esta función borra todos los ajustes de configuración de la tienda, al restaurar a su estado inicial de fábrica.

detalles

parámetros

[in] aInstance

La estructura de ejemplo OpenThread.