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 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 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 leggibile che descrive il codice di stato associato all'identificatore di profilo specificato.

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

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

Strutture
nl::Weave::Support::ProfileStringContext

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

nl::Weave::Support::ProfileStringInfo

Callback associati all'identificatore di 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 leggibile che descrive il tipo di messaggio associato all'identificatore di profilo specificato.

Questo callback, una volta registrato, viene attivato quando è necessaria una stringa C con terminazione NULL leggibile per descrivere il tipo di messaggio associato all'identificatore di 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. In caso contrario, NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

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

Questo callback, quando registrato, viene attivato quando è necessaria una stringa C con terminazione NULL leggibile per descrivere il profilo con l'identificatore di profilo specificato.

Dettagli
Parametri
[in] inProfileId
L'identificatore di profilo per il quale viene richiesta una stringa descrittiva leggibile.
Restituisce
un puntatore alla stringa C con terminazione NULL se viene trovata una corrispondenza. In caso contrario, 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 leggibile che descrive il codice di stato associato all'identificatore di profilo specificato.

Questo callback, una volta registrato, viene attivato quando è necessaria una stringa C con terminazione NULL leggibile per descrivere il codice di stato associato all'identificatore di 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. In caso contrario, NULL.

Variabili

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Puntatore head dell'elenco collegato singolarmente al registro.

Funzioni

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Trova un contesto di supporto per la stringa del profilo corrispondente a quello specificato, in base all'identificatore del profilo associato.

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; in caso contrario, NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

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

Dettagli
Parametri
[in] inProfileId
L'identificatore del profilo per cui trovare le stringhe che supportano i callback.
Restituisce
Un puntatore di sola lettura alla stringa del profilo supporta i callback, se trovato, altrimenti NULL.
Vedi anche:
RegistrationProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

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

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

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

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registra i callback di supporto per la stringa del profilo forniti.

Questa funzione registra e rende disponibili i callback di supporto delle stringhe di 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 a mano a mano che altri contesti vengono registrati o meno.
Valori restituiti
WEAVE_NO_ERROR
In caso di successo.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Se il contesto è già registrato.
Vedi anche:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

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

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; in caso contrario, false.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Annulla la registrazione dei callback di supporto per la stringa del profilo forniti.

Questa funzione annulla la registrazione e rende non disponibili i callback di supporto delle stringhe di profilo forniti.

Dettagli
Parametri
[in,out] inOutContext
Un riferimento al contesto di supporto della stringa del profilo che verrà annullata, se registrata, e rimossa dal registro. Quando il contesto non è registrato, il campo mNext può essere modificato.
Valori restituiti
WEAVE_NO_ERROR
In caso di successo.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Se il contesto non è registrato.
Vedi anche:
FindStringProfileInfo
RegistrationProfielStringInfo