nl::Weave::Support

Zusammenfassung

Typedefs
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef.
const char *(*
Typedef für eine Callback-Funktion, die einen menschenlesbaren NULL-terminierten C-String zurückgibt, der den mit der angegebenen Profilkennung verknüpften Nachrichtentyp beschreibt.
ProfileNameFunct)(uint32_t inProfileId) typedef.
const char *(*
Typedef für eine Callback-Funktion, die einen menschenlesbaren NULL-terminierten C-String zurückgibt, der das Profil mit der angegebenen Profilkennung beschreibt.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef.
const char *(*
Typedef für eine Callback-Funktion, die einen von Menschen lesbaren NULL-terminierten C-String zurückgibt, der den Statuscode beschreibt, der der angegebenen Profilkennung zugeordnet ist.

Variablen
sProfileStringContextHead
Kopfzeiger für einfach verknüpfte Registry aus der Registry.

Funktionen
FindProfileStringContext(const ProfileStringContext & inContext)
Sucht einen Profilstring-Unterstützungskontext, der mit dem angegebenen Kontext übereinstimmt, basierend auf der mit dem Kontext verknüpften Profilkennung.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Findet, sofern registriert, den Profilstring, der Rückrufe unterstützt, die mit der angegebenen Profil-ID verknüpft sind.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Fügt den angegebenen Profilstring-Supportkontext in die Registry ein.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registriert die Callbacks zur Unterstützung von Profilstrings.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Entfernt den angegebenen Supportkontext des Profilstrings aus der Registry.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Hebt die Registrierung der bereitgestellten Profilstring-Support-Callbacks auf.

Strukturen
nl::Weave::Support::ProfileStringContext

Kontext zum Registrieren und Aufheben von Callbacks, die mit der angegebenen Profilkennung verknüpft sind, um menschenlesbare Supportstrings zurückzugeben, die mit dem Profil verknüpft sind.

nl::Weave::Support::ProfileStringInfo

Callbacks, die mit der angegebenen Profilkennung verknüpft sind, um für Menschen lesbare Supportstrings zurückzugeben, die mit dem Profil verknüpft sind.

Typedefs

MessageNameFunct

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

Typedef für eine Callback-Funktion, die einen menschenlesbaren NULL-terminierten C-String zurückgibt, der den mit der angegebenen Profilkennung verknüpften Nachrichtentyp beschreibt.

Dieser Callback wird bei der Registrierung aufgerufen, wenn ein menschenlesbarer NULL-terminierter C-String erforderlich ist, um den mit der angegebenen Profilkennung verknüpften Nachrichtentyp zu beschreiben.

Details
Parameter
[in] inProfileId
Die Profil-ID, die dem angegebenen Nachrichtentyp zugeordnet ist.
[in] inMsgType
Der Nachrichtentyp, für den ein menschenlesbarer beschreibender String gesucht wird.
Rückgabe
einen Zeiger auf den mit NULL beendeten C-String, wenn eine Übereinstimmung gefunden wird; andernfalls NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef für eine Callback-Funktion, die einen menschenlesbaren NULL-terminierten C-String zurückgibt, der das Profil mit der angegebenen Profilkennung beschreibt.

Dieser Callback wird bei der Registrierung aufgerufen, wenn ein menschenlesbarer NULL-terminierter C-String erforderlich ist, um das Profil mit der angegebenen Profilkennung zu beschreiben.

Details
Parameter
[in] inProfileId
Die Profilkennung, für die ein menschenlesbarer beschreibender String gesucht wird.
Rückgabe
einen Zeiger auf den mit NULL beendeten C-String, wenn eine Übereinstimmung gefunden wird; andernfalls NULL.

StatusReportFormatStringFunct

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

Typedef für eine Callback-Funktion, die einen von Menschen lesbaren NULL-terminierten C-String zurückgibt, der den Statuscode beschreibt, der der angegebenen Profilkennung zugeordnet ist.

Dieser Callback wird bei der Registrierung aufgerufen, wenn ein menschenlesbarer NULL-terminierter C-String erforderlich ist, um den Statuscode zu beschreiben, der mit der angegebenen Profilkennung verknüpft ist.

Details
Parameter
[in] inProfileId
Die Profil-ID, die mit dem angegebenen Statuscode verknüpft ist.
[in] inStatusCode
Der Statuscode, für den ein menschenlesbarer beschreibender String gesucht wird.
Rückgabe
einen Zeiger auf den mit NULL beendeten C-String, wenn eine Übereinstimmung gefunden wird; andernfalls NULL.

Variablen

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Kopfzeiger für einfach verknüpfte Registry aus der Registry.

Funktionen

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Sucht einen Profilstring-Unterstützungskontext, der mit dem angegebenen Kontext übereinstimmt, basierend auf der mit dem Kontext verknüpften Profilkennung.

Diese Funktion sucht einen Profilstring-Unterstützungskontext, der mit dem angegebenen Kontext übereinstimmt, basierend auf der mit dem Kontext verknüpften Profilkennung.

Details
Parameter
[in] inContext
Ein schreibgeschützter Verweis auf den zu suchenden Supportkontext des Profilstrings.
Rückgabe
einen schreibgeschützten Zeiger auf den Supportkontext des Profilstrings, falls gefunden; andernfalls NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Findet, sofern registriert, den Profilstring, der Rückrufe unterstützt, die mit der angegebenen Profil-ID verknüpft sind.

Details
Parameter
[in] inProfileId
Die Profil-ID, für die Stringunterstützungsrückrufe gefunden werden sollen.
Rückgabe
einen schreibgeschützten Zeiger auf den Profilstring, der Rückrufe unterstützt, falls gefunden; andernfalls NULL.
Siehe auch:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Fügt den angegebenen Profilstring-Supportkontext in die Registry ein.

Diese Funktion fügt den angegebenen Profilstring-Unterstützungskontext in die Registry ein, falls nicht bereits vorhanden, in sortierter Reihenfolge basierend auf der aufsteigenden Profilkennung.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Supportkontext des Profilstrings, der in die Registry eingefügt wird. Solange der Kontext in der Registrierung vorhanden ist, kann das Feld „mNext“ geändert werden, wenn andere Kontexte eingefügt oder entfernt werden.
Rückgabe
true, wenn der Kontext eingefügt wurde; Andernfalls „false“.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registriert die Callbacks zur Unterstützung von Profilstrings.

Diese Funktion registriert und stellt die bereitgestellten Profilstring-Unterstützungsrückrufe zur Verfügung.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Supportkontext des Profilstrings, der registriert und der Registry hinzugefügt wird. Während der Kontext registriert ist, kann das Feld „mNext“ geändert werden, wenn andere Kontexte registriert oder nicht registriert sind.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Wenn der Kontext bereits registriert ist.
Siehe auch:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Entfernt den angegebenen Supportkontext des Profilstrings aus der Registry.

Diese Funktion entfernt den angegebenen Supportkontext des Profilstrings aus der Registrierung, falls vorhanden, basierend auf der Profilkennung.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Supportkontext des Profilstrings, der gegebenenfalls entfernt wird. Wenn der Kontext entfernt wird, kann das Feld „mNext“ geändert werden.
Rückgabe
true, wenn der Kontext entfernt wurde; Andernfalls „false“.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Hebt die Registrierung der bereitgestellten Profilstring-Support-Callbacks auf.

Diese Funktion hebt die Registrierung der bereitgestellten Profilstring-Support-Callbacks auf und macht sie nicht mehr verfügbar.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Supportkontext des Profilstrings, der abgemeldet und aus der Registry entfernt wird, falls er registriert ist. Wenn der Kontext nicht registriert ist, kann das Feld „mNext“ geändert werden.
Rückgabewerte
WEAVE_NO_ERROR
Bei Erfolg.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Wenn der Kontext nicht registriert ist.
Siehe auch:
FindStringProfileInfo
RegisterProfielStringInfo