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 Nachrichtentyp beschreibt, der mit der angegebenen Profilkennung verknüpft ist.
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 menschenlesbaren NULL-terminierten C-String zurückgibt, der den mit der angegebenen Profilkennung verknüpften Statuscode beschreibt.

Variablen
sProfileStringContextHead
Kopfzeiger der Liste mit einer einzelnen Registry.

Funktionen
FindProfileStringContext(const ProfileStringContext & inContext)
Supportkontext für einen Profilstring suchen, 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, falls registriert, unterstützt der Profilstring Rückrufe, die mit der angegebenen Profilkennung verknüpft sind.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Fügt den angegebenen Supportkontext für den Profilstring in die Registry ein.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registrieren Sie den angegebenen Profilstring, der Callbacks unterstützt.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Entfernen Sie den angegebenen Supportkontext für den Profilstring aus der Registry.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Heben Sie die Registrierung der Support-Callbacks für den angegebenen Profilstring auf.

Strukturen
nl::Weave::Support::ProfileStringContext

Kontext zum Registrieren und Aufheben der Registrierung von Rückrufen, die mit der angegebenen Profilkennung verknüpft sind, um menschenlesbare Support-Strings zurückzugeben, die dem Profil zugeordnet sind.

nl::Weave::Support::ProfileStringInfo

Callbacks, die mit der angegebenen Profilkennung verknüpft sind, um menschenlesbare Support-Strings zurückzugeben, die dem Profil zugeordnet 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 Nachrichtentyp beschreibt, der mit der angegebenen Profilkennung verknüpft ist.

Dieser Callback wird, wenn er registriert, aufgerufen, wenn ein lesbarer NULL-terminierter C-String benötigt wird, um den Nachrichtentyp zu beschreiben, der der angegebenen Profilkennung zugeordnet ist.

Details
Parameter
[in] inProfileId
Die Profilkennung, die dem angegebenen Nachrichtentyp zugeordnet ist.
[in] inMsgType
Der Nachrichtentyp, für den ein menschenlesbarer beschreibender String gesucht wird.
Rückgabe
Ein Zeiger auf den NULL-terminierten 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, wenn er registriert wird, aufgerufen, wenn ein lesbarer NULL-terminierter C-String benötigt wird, um das Profil mit der angegebenen Profilkennung zu beschreiben.

Details
Parameter
[in] inProfileId
Die Profilkennung, für die eine menschenlesbare beschreibende Zeichenfolge gesucht wird.
Rückgabe
Ein Zeiger auf den NULL-terminierten 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 menschenlesbaren NULL-terminierten C-String zurückgibt, der den mit der angegebenen Profilkennung verknüpften Statuscode beschreibt.

Dieser Callback wird, wenn er registriert, aufgerufen, wenn eine visuell lesbare NULL-terminierte C-Zeichenfolge benötigt wird, um den Statuscode zu beschreiben, der mit der angegebenen Profilkennung verknüpft ist.

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

Variablen

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Kopfzeiger der Liste mit einer einzelnen Registry.

Funktionen

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Supportkontext für einen Profilstring suchen, der mit dem angegebenen Kontext übereinstimmt, basierend auf der mit dem Kontext verknüpften Profilkennung.

Diese Funktion findet einen Profilstring-Supportkontext, 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 Supportkontext des Profilstrings, der gesucht werden soll.
Rückgabe
Ein schreibgeschützter Zeiger auf den Supportkontext des Profilstrings, falls dieser gefunden wird, andernfalls NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Findet, falls registriert, unterstützt der Profilstring Rückrufe, die mit der angegebenen Profilkennung verknüpft sind.

Details
Parameter
[in] inProfileId
Die Profil-ID, für die Rückrufe für die Stringunterstützung gesucht werden sollen.
Rückgabe
Ein schreibgeschützter Zeiger auf den Profilstring unterstützt Callbacks, falls gefunden. Andernfalls NULL.
Siehe auch:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

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

Diese Funktion fügt den angegebenen Supportkontext für den Profilstring in die Registry ein, sofern noch nicht 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 Registry 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
)

Registrieren Sie den angegebenen Profilstring, der Callbacks unterstützt.

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 wird, kann das Feld „mNext“ geändert werden, wenn andere Kontexte registriert oder nicht registriert werden.
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
)

Entfernen Sie den angegebenen Supportkontext für den Profilstring aus der Registry.

Diese Funktion entfernt den angegebenen Supportkontext für den Profilstring anhand der Profilkennung, falls vorhanden, aus der Registry.

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
)

Heben Sie die Registrierung der Support-Callbacks für den angegebenen Profilstring auf.

Diese Funktion hebt die Registrierung auf und macht den angegebenen Profilstring-Supportrückruf nicht verfügbar.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Supportkontext des Profilstrings, der nicht registriert, registriert und aus der Registry entfernt wird. Wenn die Registrierung des Kontexts aufgehoben wird, 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