nl::Weave::Support

Resumen

Typedefs
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef para una función de devolución de llamada que muestra una string C terminada en NULL y legible que describe el tipo de mensaje asociado con el identificador de perfil especificado.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef para una función de devolución de llamada que muestra una string C terminada en NULL y legible que describe el perfil con el identificador de perfil especificado.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef para una función de devolución de llamada que muestra una string C terminada en NULL, legible por humanos, que describe el código de estado asociado con el identificador de perfil especificado.

Variables
sProfileStringContextHead
Puntero principal de la lista vinculada de forma única.

Funciones
FindProfileStringContext(const ProfileStringContext & inContext)
Encuentra un contexto de compatibilidad de cadena de perfil que coincida con el contexto especificado, según el identificador de perfil asociado con el contexto.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Si se registra, la string de perfil admite devoluciones de llamada asociadas con el identificador de perfil especificado.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Inserta el contexto de compatibilidad de la cadena de perfil especificada en el registro.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registra las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Quita del registro el contexto de compatibilidad de la cadena de perfil especificada.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Cancela el registro de las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.

Structs
nl::Weave::Support::ProfileStringContext

Contexto para registrar y anular el registro de devoluciones de llamada asociadas con el identificador de perfil especificado para mostrar cadenas de asistencia legibles por humanos asociadas con el perfil.

nl::Weave::Support::ProfileStringInfo

Devoluciones de llamada asociadas con el identificador de perfil especificado para mostrar strings de asistencia legibles por humanos asociadas con el perfil.

Typedefs

MessageNameFunct

const char *(* MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType)

Typedef para una función de devolución de llamada que muestra una string C terminada en NULL y legible que describe el tipo de mensaje asociado con el identificador de perfil especificado.

Esta devolución de llamada, cuando se registra, se invoca cuando se necesita una cadena C terminada en NULL y legible para describir el tipo de mensaje asociado con el identificador de perfil especificado.

Detalles
Parámetros
[in] inProfileId
El identificador de perfil asociado con el tipo de mensaje especificado.
[in] inMsgType
Es el tipo de mensaje para el que se busca una cadena descriptiva legible por humanos.
Resultado que se muestra
un puntero a la cadena C terminada en NULL si se encuentra una coincidencia; de lo contrario, NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef para una función de devolución de llamada que muestra una string C terminada en NULL y legible que describe el perfil con el identificador de perfil especificado.

Esta devolución de llamada, cuando se registra, se invoca cuando se necesita una cadena C terminada en NULL, legible por humanos para describir el perfil con el identificador de perfil especificado.

Detalles
Parámetros
[in] inProfileId
El identificador de perfil para el que se busca una cadena descriptiva legible por humanos.
Resultado que se muestra
un puntero a la cadena C terminada en NULL si se encuentra una coincidencia; de lo contrario, NULL.

StatusReportFormatStringFunct

const char *(* StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode)

Typedef para una función de devolución de llamada que muestra una string C terminada en NULL, legible por humanos, que describe el código de estado asociado con el identificador de perfil especificado.

Esta devolución de llamada, cuando se registra, se invoca cuando se necesita una cadena C terminada en NULL, legible por humanos para describir el código de estado asociado con el identificador de perfil especificado.

Detalles
Parámetros
[in] inProfileId
El identificador de perfil asociado con el código de estado especificado.
[in] inStatusCode
El código de estado para el que se busca una cadena descriptiva legible por humanos.
Resultado que se muestra
un puntero a la cadena C terminada en NULL si se encuentra una coincidencia; de lo contrario, NULL.

Variables

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Puntero principal de la lista vinculada de forma única.

Funciones

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Encuentra un contexto de compatibilidad de cadena de perfil que coincida con el contexto especificado, según el identificador de perfil asociado con el contexto.

Esta función encuentra un contexto de compatibilidad de cadena de perfil que coincide con el contexto especificado, según el identificador de perfil asociado con el contexto.

Detalles
Parámetros
[in] inContext
Una referencia de solo lectura al contexto de compatibilidad de la string de perfil para encontrar.
Resultado que se muestra
un puntero de solo lectura al contexto de compatibilidad de la cadena de perfil si se encuentra; de lo contrario, NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Si se registra, la string de perfil admite devoluciones de llamada asociadas con el identificador de perfil especificado.

Detalles
Parámetros
[in] inProfileId
El identificador de perfil para el que se buscan devoluciones de llamada de compatibilidad con cadenas.
Resultado que se muestra
un puntero de solo lectura a la string de perfil admite devoluciones de llamada si se encuentran; de lo contrario, NULL.
Consulta también:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Inserta el contexto de compatibilidad de la cadena de perfil especificada en el registro.

Esta función inserta el contexto de compatibilidad de la cadena de perfil especificado en el registro, si aún no está presente, en orden, según el identificador de perfil ascendente.

Detalles
Parámetros
[in,out] inOutContext
Una referencia al contexto de compatibilidad de la string de perfil que se insertará en el registro. Mientras el contexto está presente en el registro, el campo mNext puede modificarse a medida que se insertan o quitan otros contextos.
Resultado que se muestra
true si se insertó el contexto; de lo contrario, es falso.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registra las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.

Esta función registra y pone a disposición las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.

Detalles
Parámetros
[in,out] inOutContext
Una referencia al contexto de compatibilidad de la cadena de perfil que se registrará y agregará al registro. Mientras se registra el contexto, el campo mNext puede modificarse a medida que se registran o no otros contextos.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Si el contexto ya está registrado.
Consulta también:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Quita del registro el contexto de compatibilidad de la cadena de perfil especificada.

Esta función quita el contexto de compatibilidad de la cadena de perfil especificado del registro, si está presente, según el identificador de perfil.

Detalles
Parámetros
[in,out] inOutContext
Una referencia al contexto de compatibilidad de la cadena de perfil que se quitará, si está presente. Cuando se quita el contexto, se puede modificar el campo mNext.
Resultado que se muestra
true si se quitó el contexto; de lo contrario, es falso.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Cancela el registro de las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.

Esta función cancela el registro y deja de estar disponible las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.

Detalles
Parámetros
[in,out] inOutContext
Una referencia a la cadena de perfil admite contexto que, si está registrado, no se registrará y que se quitará del registro. Cuando no se registra el contexto, se puede modificar el campo mNext.
Valores de retorno
WEAVE_NO_ERROR
Si tiene éxito.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Si el contexto no está registrado.
Consulta también:
FindStringProfileInfo
RegisterProfielStringInfo