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 cadena C terminada en NULL 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 cadena C terminada en NULL 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 cadena C terminada en NULL y legible que describe el código de estado asociado con el identificador de perfil especificado

Variables

sProfileStringContextHead
Puntero principal de lista vinculado del registro.

remotas

FindProfileStringContext(const ProfileStringContext & inContext)
Buscar una cadena de perfil que admita un contexto 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 *
Busca, si está registrada, 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 string de perfil especificado en el registro.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registra las devoluciones de llamada proporcionadas de compatibilidad de la string de perfil.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Quita el contexto de compatibilidad de string de perfil especificado del registro.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Cancela el registro de las devoluciones de llamada de compatibilidad de la string de perfil proporcionadas.

Structs

nl::Weave::Support::ProfileStringContext

Contexto para registrar y anular el registro de devoluciones de llamada asociadas con el identificador de perfil especificado a fin de mostrar strings de compatibilidad 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 compatibilidad 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 cadena C terminada en NULL que describe el tipo de mensaje asociado con el identificador de perfil especificado

Cuando se registra esta devolución de llamada, se invoca cuando se necesita una cadena C terminada en NULL 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.
Qué 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 cadena C terminada en NULL que describe el perfil con el identificador de perfil especificado

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

Detalles
Parámetros
[in] inProfileId
Es el identificador de perfil para el que se busca una cadena descriptiva legible.
Qué 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 cadena C terminada en NULL y legible que describe el código de estado asociado con el identificador de perfil especificado

Cuando se registra esta devolución de llamada, se invoca cuando se necesita una cadena C terminada en NULL legible 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
Es el código de estado para el que se busca una cadena descriptiva legible.
Qué 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 lista vinculado del registro.

remotas

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Buscar una cadena de perfil que admita un contexto que coincida con el contexto especificado, según el identificador de perfil asociado con el contexto

Esta función encuentra una string de perfil que admite contextos que coincidan con el contexto especificado, según el identificador de perfil asociado con el contexto.

Detalles
Parámetros
[in] inContext
Es una referencia de solo lectura al contexto de asistencia de la cadena de perfil que se debe buscar.
Qué muestra
un puntero de solo lectura para la string de perfil admite contexto si se encuentra; de lo contrario, es NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Busca, si está registrada, 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 deben encontrar las devoluciones de llamada compatibles con la cadena.
Qué muestra
un puntero de solo lectura para la string de perfil admite devoluciones de llamada si se encuentra; de lo contrario, NULL.
Consulta también:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Inserta el contexto de compatibilidad de la string de perfil especificado en el registro.

Esta función inserta el contexto de compatibilidad de la string de perfil especificada 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 asistencia de la string de perfil que se insertará en el registro. Mientras el contexto esté presente en el registro, el campo mNext se puede modificar a medida que se insertan o quitan otros contextos.
Qué 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 proporcionadas de compatibilidad de la string de perfil.

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

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

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Quita el contexto de compatibilidad de string de perfil especificado del registro.

Esta función quita el contexto de compatibilidad de string 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 string de perfil que se quitará, si está presente. Cuando se quita el contexto, se puede modificar el campo mNext.
Qué 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 proporcionadas.

Con esta función, se cancela el registro y se inhabilitan las devoluciones de llamada de compatibilidad de la string de perfil proporcionada.

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