nl::Weave::Support

Resumo

Typedefs
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef para uma função de callback que retorna uma string C terminada em NULL legível por humanos, que descreve o tipo de mensagem associado ao identificador de perfil especificado.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef para uma função de callback que retorna uma string C terminada em NULL legível que descreve o perfil com o identificador de perfil especificado.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef para uma função de callback que retorna uma string C terminada em NULL legível por humanos que descreve o código de status associado ao identificador de perfil especificado.

Variáveis
sProfileStringContextHead
Ponteiro do cabeçalho da lista vinculada apenas ao registro.

Funções
FindProfileStringContext(const ProfileStringContext & inContext)
Encontre um contexto de suporte de string de perfil correspondente ao contexto especificado, com base no identificador de perfil associado ao contexto.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Encontre, se registrada, a string de perfil é compatível com callbacks associados ao identificador de perfil especificado.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Insira o contexto de suporte da string de perfil especificada no registro.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registre a string de perfil fornecida com os callbacks de suporte.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Remova o contexto de suporte da string de perfil especificada do registro.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Cancele o registro da string de perfil fornecida que aceita callbacks.

Estruturas
nl::Weave::Support::ProfileStringContext

Contexto para registrar e cancelar o registro de callbacks associados ao identificador de perfil especificado para retornar strings de suporte legíveis associadas ao perfil.

nl::Weave::Support::ProfileStringInfo

Callbacks associados ao identificador de perfil especificado para retornar strings de suporte legíveis associadas ao perfil.

Typedefs

MessageNameFunct

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

Typedef para uma função de callback que retorna uma string C terminada em NULL legível por humanos, que descreve o tipo de mensagem associado ao identificador de perfil especificado.

Esse callback, quando registrado, é invocado quando uma string C terminada em NULL legível por humanos é necessária para descrever o tipo de mensagem associado ao identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador de perfil associado ao tipo de mensagem especificado.
[in] inMsgType
O tipo de mensagem para o qual é procurada uma string descritiva legível.
Retornos
um ponteiro para a string C terminada em NULL, se uma correspondência for encontrada; caso contrário, NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef para uma função de callback que retorna uma string C terminada em NULL legível que descreve o perfil com o identificador de perfil especificado.

Esse callback, quando registrado, é invocado quando uma string C terminada em NULL legível por humanos é necessária para descrever o perfil com o identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador de perfil para o qual uma string descritiva legível é buscada.
Retornos
um ponteiro para a string C terminada em NULL, se uma correspondência for encontrada; caso contrário, NULL.

StatusReportFormatStringFunct

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

Typedef para uma função de callback que retorna uma string C terminada em NULL legível por humanos que descreve o código de status associado ao identificador de perfil especificado.

Esse retorno de chamada, quando registrado, é invocado quando uma string C terminada em NULL legível por humanos é necessária para descrever o código de status associado ao identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador de perfil associado ao código de status especificado.
[in] inStatusCode
O código de status para o qual uma string descritiva legível é buscada.
Retornos
um ponteiro para a string C terminada em NULL, se uma correspondência for encontrada; caso contrário, NULL.

Variáveis

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Ponteiro do cabeçalho da lista vinculada apenas ao registro.

Funções

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Encontre um contexto de suporte de string de perfil correspondente ao contexto especificado, com base no identificador de perfil associado ao contexto.

Essa função encontra um contexto de suporte de string de perfil correspondente ao contexto especificado, com base no identificador de perfil associado ao contexto.

Detalhes
Parâmetros
[in] inContext
Uma referência somente leitura ao contexto de suporte da string de perfil a ser encontrado.
Retornos
um ponteiro somente leitura para o contexto de suporte da string de perfil, se encontrado; caso contrário, NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Encontre, se registrada, a string de perfil é compatível com callbacks associados ao identificador de perfil especificado.

Detalhes
Parâmetros
[in] inProfileId
O identificador do perfil para encontrar os callbacks de suporte da string.
Retornos
um ponteiro somente leitura para a string de perfil oferece suporte a callbacks, se encontrados; caso contrário, NULL.
Confira também:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Insira o contexto de suporte da string de perfil especificada no registro.

Essa função insere o contexto de suporte da string de perfil especificada no registro, se ainda não estiver presente, em ordem classificada, com base no identificador de perfil crescente.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string do perfil que será inserida no registro. Enquanto o contexto está presente no registro, o campo mNext pode ser modificado à medida que outros contextos são inseridos ou removidos.
Retornos
verdadeiro se o contexto foi inserido; caso contrário, falso.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registre a string de perfil fornecida com os callbacks de suporte.

Essa função registra e disponibiliza a string de perfil fornecida com suporte a callbacks.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string do perfil que será registrado e adicionado ao registro. Enquanto o contexto estiver registrado, o campo "mNext" poderá ser modificado à medida que outros contextos forem registrados ou não.
Valores de retorno
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Se o contexto já estiver registrado.
Confira também:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Remova o contexto de suporte da string de perfil especificada do registro.

Essa função remove o contexto de suporte da string de perfil especificada do registro, se presente, com base no identificador de perfil.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string do perfil que será removido, se houver. Quando o contexto é removido, o campo "mNext" pode ser modificado.
Retornos
verdadeiro se o contexto foi removido; caso contrário, falso.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Cancele o registro da string de perfil fornecida que aceita callbacks.

Essa função cancela o registro e torna indisponível a string de perfil fornecida com suporte a callbacks.

Detalhes
Parâmetros
[in,out] inOutContext
Uma referência ao contexto de suporte da string do perfil que vai ter o registro cancelado, se registrado, e removido do registro. Quando o contexto não é registrado, o campo "mNext" pode ser modificado.
Valores de retorno
WEAVE_NO_ERROR
Se a operação for bem-sucedida.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Se o contexto não estiver registrado.
Confira também:
FindStringProfileInfo
RegisterProfielStringInfo