nl::Weave::Support

Riepilogo

Typedef
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef per una funzione di callback che restituisce una stringa C con terminazione NULL e leggibile che descrive il tipo di messaggio associato all'identificatore di profilo specificato.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef per una funzione di callback che restituisce una stringa C con terminazione NULL e leggibile che descrive il profilo con l'identificatore di profilo specificato.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef per una funzione di callback che restituisce una stringa C con terminazione NULL e leggibile che descrive il codice di stato associato all'identificatore di profilo specificato.

Variabili
sProfileStringContextHead
Puntatore dell'intestazione dell'elenco collegato singolarmente al registro.

Funzioni
FindProfileStringContext(const ProfileStringContext & inContext)
Trova un contesto di supporto della stringa del profilo corrispondente al contesto specificato, in base all'identificatore del profilo associato al contesto.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Trova, se registrata, la stringa del profilo supporta i callback associati all'identificatore del profilo specificato.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Inserisci nel registro il contesto di supporto della stringa del profilo specificato.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registra il callback di supporto della stringa del profilo fornito.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Rimuovi dal registro il contesto di supporto della stringa del profilo specificato.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Annulla la registrazione della stringa del profilo fornita, che supporta i callback.

Structs
nl::Weave::Support::ProfileStringContext

Contesto per la registrazione e l'annullamento della registrazione dei callback associati all'identificatore del profilo specificato per restituire stringhe di supporto leggibili associate al profilo.

nl::Weave::Support::ProfileStringInfo

Callback associati all'identificatore del profilo specificato per la restituzione di stringhe di supporto leggibili associate al profilo.

Typedef

MessageNameFunct

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

Typedef per una funzione di callback che restituisce una stringa C con terminazione NULL e leggibile che descrive il tipo di messaggio associato all'identificatore di profilo specificato.

Se registrato, questo callback viene richiamato quando è necessaria una stringa C con terminazione NULL e leggibile per descrivere il tipo di messaggio associato all'identificatore del profilo specificato.

Dettagli
Parametri
[in] inProfileId
L'identificatore del profilo associato al tipo di messaggio specificato.
[in] inMsgType
Il tipo di messaggio per il quale viene richiesta una stringa descrittiva leggibile.
Restituisce
un puntatore alla stringa C con terminazione NULL se viene trovata una corrispondenza; altrimenti NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef per una funzione di callback che restituisce una stringa C con terminazione NULL e leggibile che descrive il profilo con l'identificatore di profilo specificato.

Se registrato, questo callback viene richiamato quando è necessaria una stringa C con terminazione NULL e leggibile da una persona per descrivere il profilo con l'identificatore di profilo specificato.

Dettagli
Parametri
[in] inProfileId
L'identificatore del profilo per il quale viene richiesta una stringa descrittiva leggibile.
Restituisce
un puntatore alla stringa C con terminazione NULL se viene trovata una corrispondenza; altrimenti NULL.

StatusReportFormatStringFunct

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

Typedef per una funzione di callback che restituisce una stringa C con terminazione NULL e leggibile che descrive il codice di stato associato all'identificatore del profilo specificato.

Se registrato, questo callback viene richiamato quando è necessaria una stringa C con terminazione NULL e leggibile per descrivere il codice di stato associato all'identificatore del profilo specificato.

Dettagli
Parametri
[in] inProfileId
L'identificatore del profilo associato al codice di stato specificato.
[in] inStatusCode
Il codice di stato per il quale viene richiesta una stringa descrittiva leggibile.
Restituisce
un puntatore alla stringa C con terminazione NULL se viene trovata una corrispondenza; altrimenti NULL.

Variabili

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Puntatore dell'intestazione dell'elenco collegato singolarmente al registro.

Funzioni

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Trova un contesto di supporto della stringa del profilo corrispondente al contesto specificato, in base all'identificatore del profilo associato al contesto.

Questa funzione trova un contesto di supporto della stringa del profilo corrispondente al contesto specificato, in base all'identificatore del profilo associato al contesto.

Dettagli
Parametri
[in] inContext
Un riferimento di sola lettura al contesto di supporto della stringa del profilo da trovare.
Restituisce
un puntatore di sola lettura al contesto di supporto della stringa del profilo, se trovato; altrimenti NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Trova, se registrata, la stringa del profilo supporta i callback associati all'identificatore del profilo specificato.

Dettagli
Parametri
[in] inProfileId
L'identificatore del profilo per cui trovare i callback di supporto delle stringhe.
Restituisce
un puntatore di sola lettura alla stringa del profilo, se presente, supporta i callback; altrimenti NULL.
Vedi anche:
RegistraProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Inserisci nel registro il contesto di supporto della stringa del profilo specificato.

Questa funzione inserisce nel registro il contesto di supporto della stringa del profilo specificato, se non è già presente, in ordine, in base all'identificatore del profilo crescente.

Dettagli
Parametri
[in,out] inOutContext
Un riferimento al contesto di supporto della stringa del profilo che verrà inserito nel registro. Mentre il contesto è presente nel registro, il campo mNext può essere modificato man mano che vengono inseriti o rimossi altri contesti.
Restituisce
true se il contesto è stato inserito; altrimenti false.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registra i callback di supporto della stringa del profilo fornita.

Questa funzione registra e rende disponibili i callback di supporto della stringa del profilo forniti.

Dettagli
Parametri
[in,out] inOutContext
Un riferimento al contesto di supporto della stringa del profilo che verrà registrato e aggiunto al registro. Mentre il contesto è registrato, il campo mNext può essere modificato man mano che gli altri contesti sono registrati o non registrati.
Valori restituiti
WEAVE_NO_ERROR
Un successo.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Se il contesto è già registrato.
Vedi anche:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Rimuovi dal registro il contesto di supporto della stringa del profilo specificato.

Questa funzione rimuove dal registro il contesto di supporto della stringa del profilo specificato, se presente, in base all'identificatore del profilo.

Dettagli
Parametri
[in,out] inOutContext
Un riferimento al contesto di supporto della stringa del profilo che verrà rimosso, se presente. Quando il contesto viene rimosso, il campo mNext può essere modificato.
Restituisce
true se il contesto è stato rimosso; altrimenti false.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Annulla la registrazione della stringa del profilo fornita, che supporta i callback.

Questa funzione annulla la registrazione e rende non disponibile la stringa del profilo fornita che supporta i callback.

Dettagli
Parametri
[in,out] inOutContext
Un riferimento alla stringa del profilo supporta il contesto che verrà annullato, se registrato, e rimosso dal registro. Se la registrazione del contesto non è attiva, il campo mNext potrebbe essere modificato.
Valori restituiti
WEAVE_NO_ERROR
Un successo.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Se il contesto non è registrato.
Vedi anche:
FindStringProfileInfo
RegistraProfielStringInfo