Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Support

Fazit

Typdef.

MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) Typdef
const char *(*
Typedef für eine Callback-Funktion, die einen für Menschen lesbaren NULL-beendeten C-String zurückgibt, der den Nachrichtentyp angibt, der mit der angegebenen Profil-ID verknüpft ist.
ProfileNameFunct)(uint32_t inProfileId) Typdef
const char *(*
Typedef für eine Callback-Funktion, die einen für Menschen lesbaren NULL-beendeten C-String zurückgibt, der das Profil mit der angegebenen Profil-ID beschreibt.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) Typdef
const char *(*
Typedef für eine Callback-Funktion, die einen für Menschen lesbaren NULL-beendeten C-String zurückgibt, der den Statuscode der angegebenen Profil-ID beschreibt.

Variablen

sProfileStringContextHead
Kopf-Zeiger, der mit der Registry verknüpft ist.

Funktionen

FindProfileStringContext(const ProfileStringContext & inContext)
Finden Sie basierend auf der mit dem Kontext verknüpften Profil-ID einen Unterstützungskontext für einen Profilstring, der mit dem angegebenen Kontext übereinstimmt.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Suchen Sie nach dem registrierten String, der Callbacks unterstützt, die mit der angegebenen Profil-ID verknüpft sind.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Fügen Sie den angegebenen Supportstring für den Profilstring in die Registry ein.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Registriere die angegebenen Profilstring-Unterstützungs-Callbacks.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Entfernen Sie den angegebenen Supportstring für das Profilstring aus der Registry.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Heben Sie die Registrierung des unterstützten Callbacks für den Profilstring auf.

Strebenklemmen

nl::Weave::Support::ProfileStringContext

Kontext zum Registrieren und Entfernen der Callbacks, die der angegebenen Profil-ID zugeordnet sind, um menschenlesbare Supportstrings im Profil zurückzugeben.

nl::Weave::Support::ProfileStringInfo

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

Typdef.

NachrichtennameFunct

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

Typedef für eine Callback-Funktion, die einen für Menschen lesbaren NULL-beendeten C-String zurückgibt, der den Nachrichtentyp angibt, der mit der angegebenen Profil-ID verknüpft ist.

Dieser Callback wird bei Registrierung aufgerufen, wenn ein für Menschen lesbarer NULL-konformer C-String erforderlich ist, um den Nachrichtentyp zu beschreiben, der mit der angegebenen Profil-ID verknüpft ist.

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

ProfilnameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef für eine Callback-Funktion, die einen für Menschen lesbaren NULL-beendeten C-String zurückgibt, der das Profil mit der angegebenen Profil-ID beschreibt.

Dieser Callback wird bei Registrierung aufgerufen, wenn ein für Menschen lesbarer NULL-konformer C-String erforderlich ist, um das Profil mit der angegebenen Profil-ID zu beschreiben.

Details
Parameter
[in] inProfileId
Die Profil-ID, für die ein von Menschen lesbarer beschreibender String gesucht wird.
Rückgabe
einen Zeiger auf den NULL-beendeten C-String, wenn eine Übereinstimmung gefunden wird. Andernfalls ist NULL.

StatusReportFormatStringFunct

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

Typedef für eine Callback-Funktion, die einen für Menschen lesbaren NULL-beendeten C-String zurückgibt, der den Statuscode der angegebenen Profil-ID beschreibt.

Dieser Callback wird ausgelöst, wenn er für Menschen lesbarer NULL-konformer C-String ist, um den mit der angegebenen Profil-ID verknüpften Statuscode zu beschreiben.

Details
Parameter
[in] inProfileId
Die Profil-ID, die dem angegebenen Statuscode zugeordnet ist.
[in] inStatusCode
Der Statuscode, für den ein von Menschen lesbarer beschreibender String gesucht wird
Rückgabe
einen Zeiger auf den NULL-beendeten C-String, wenn eine Übereinstimmung gefunden wird. Andernfalls ist NULL.

Variablen

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Kopf-Zeiger, der mit der Registry verknüpft ist.

Funktionen

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Finden Sie basierend auf der mit dem Kontext verknüpften Profil-ID einen Unterstützungskontext für einen Profilstring, der mit dem angegebenen Kontext übereinstimmt.

Diese Funktion findet einen Profilstring, der den angegebenen Kontext unterstützt, basierend auf der Profil-ID, die mit dem Kontext verknüpft ist.

Details
Parameter
[in] inContext
Eine schreibgeschützte Referenz zum Profilstring-Support, der gefunden werden soll.
Rückgabe
Einen schreibgeschützten Zeiger auf den Profilstring-Supportkontext, falls gefunden. Andernfalls NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Suchen Sie nach dem registrierten String, der Callbacks unterstützt, die mit der angegebenen Profil-ID verknüpft sind.

Details
Parameter
[in] inProfileId
Die Profil-ID, für die String-Support-Callbacks gefunden 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ügen Sie den angegebenen Supportstring für den Profilstring in die Registry ein.

Diese Funktion fügt den angegebenen Unterstützungskontext für Profilstrings in die Registry ein, falls noch nicht vorhanden, in sortierter Reihenfolge, basierend auf aufsteigender Profil-ID.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Profilstring-Supportkontext, der in die Registrierung eingefügt wird. Während der Kontext in der Registry vorhanden ist, kann das mNext-Feld geändert werden, wenn andere Kontexte eingefügt oder entfernt werden.
Rückgabe
True, wenn der Kontext eingefügt wurde. Andernfalls lautet sie False.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Registriere die angegebenen Profilstring-Unterstützungs-Callbacks.

Diese Funktion registriert und stellt die bereitgestellten Profilstring-Unterstützungs-Callbacks zur Verfügung.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Supportstring für den Profilstring, der registriert und der Registry hinzugefügt wird. Solange der Kontext registriert ist, kann das mNext-Feld geändert werden, wenn andere Kontexte registriert oder nicht registriert sind.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Wenn der Kontext bereits registriert ist.
Siehe auch:
FindStringProfileInfo
UnregisterProfielStringInfo

ProfileStringContext entfernen

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

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

Diese Funktion entfernt den angegebenen Supportstring für den Profilstring aus der Registry, sofern vorhanden, basierend auf der Profil-ID.

Details
Parameter
[in,out] inOutContext
Eine Referenz zum Kontext des Profilstrings, die entfernt wird, sofern vorhanden. Wenn der Kontext entfernt wird, kann das Feld „mNext“ geändert werden.
Rückgabe
True, wenn der Kontext entfernt wurde. Andernfalls lautet False.

Registrierung des Profilstrings aufheben

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Heben Sie die Registrierung des unterstützten Callbacks für den Profilstring auf.

Mit dieser Funktion wird die Registrierung aufgehoben und die angegebenen Callbacks für den Profilstring sind nicht mehr verfügbar.

Details
Parameter
[in,out] inOutContext
Ein Verweis auf den Kontext des Profilstrings, der nicht registriert, registriert und aus der Registry entfernt wird. Wenn der Kontext nicht registriert ist, wird das mNext-Feld unter Umständen geändert.
Rückgabewerte
WEAVE_NO_ERROR
Erfolg.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Wenn der Kontext nicht registriert ist.
Siehe auch:
FindStringProfileInfo
RegisterProfielStringInfo