nl::Weave::Support

Résumé

Typedefs

MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef pour une fonction de rappel qui renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le type de message associé à l'identifiant de profil spécifié.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef pour une fonction de rappel qui renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le profil avec l'identifiant de profil spécifié.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef pour une fonction de rappel qui renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le code d'état associé à l'identifiant de profil spécifié.

Variables

sProfileStringContextHead
Pointeur en-tête de liste à lien unique du registre.

distantes

FindProfileStringContext(const ProfileStringContext & inContext)
Recherche un contexte de prise en charge de la chaîne de profil correspondant au contexte spécifié, en fonction de l'identifiant de profil associé au contexte.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Permet de rechercher, si elle est enregistrée, les rappels associés à l'identifiant de profil spécifié pour la chaîne de profil.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Insérez le contexte de support de la chaîne de profil spécifiée dans le registre.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Enregistre les rappels de prise en charge de la chaîne de profil fournie.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Supprimez le contexte de prise en charge de la chaîne de profil spécifiée du registre.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Annulez l'enregistrement des rappels pris en charge par la chaîne de profil fournie.

Structs

nl::Weave::Support::ProfileStringContext

Contexte d'enregistrement et d'annulation de l'enregistrement des rappels associés à l'identifiant de profil spécifié pour renvoyer des chaînes d'assistance lisibles associées au profil.

nl::Weave::Support::ProfileStringInfo

Rappels associés à l'identifiant de profil spécifié pour renvoyer des chaînes d'assistance lisibles par l'humain associées au profil.

Typedefs

MessageNameFunct

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

Typedef pour une fonction de rappel qui renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le type de message associé à l'identifiant de profil spécifié.

Une fois enregistré, ce rappel est appelé lorsqu'une chaîne C lisible par l'humain se terminant par une valeur NULL est nécessaire pour décrire le type de message associé à l'identifiant de profil spécifié.

Détails
Paramètres
[in] inProfileId
Identifiant de profil associé au type de message spécifié.
[in] inMsgType
Type de message pour lequel une chaîne descriptive lisible par l'utilisateur est recherchée.
Renvoie
un pointeur vers la chaîne C terminée par la valeur NULL si une correspondance est trouvée ; sinon, la valeur est NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef pour une fonction de rappel qui renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le profil avec l'identifiant de profil spécifié.

Une fois enregistré, ce rappel est appelé lorsqu'une chaîne C lisible par l'humain se terminant par une valeur NULL est nécessaire pour décrire le profil avec l'identifiant de profil spécifié.

Détails
Paramètres
[in] inProfileId
Identifiant du profil pour lequel une chaîne descriptive lisible par l'utilisateur est recherchée.
Renvoie
un pointeur vers la chaîne C terminée par la valeur NULL si une correspondance est trouvée ; sinon, la valeur est NULL.

StatusReportFormatStringFunct

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

Typedef pour une fonction de rappel qui renvoie une chaîne C lisible se terminant par une valeur NULL décrivant le code d'état associé à l'identifiant de profil spécifié.

Une fois enregistré, ce rappel est appelé lorsqu'une chaîne C lisible par l'humain se terminant par une valeur NULL est nécessaire pour décrire le code d'état associé à l'identifiant de profil spécifié.

Détails
Paramètres
[in] inProfileId
Identifiant de profil associé au code d'état spécifié.
[in] inStatusCode
Code d'état pour lequel une chaîne descriptive lisible par l'utilisateur est recherchée.
Renvoie
un pointeur vers la chaîne C terminée par la valeur NULL si une correspondance est trouvée ; sinon, la valeur est NULL.

Variables

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Pointeur en-tête de liste à lien unique du registre.

distantes

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Recherche un contexte de prise en charge de la chaîne de profil correspondant au contexte spécifié, en fonction de l'identifiant de profil associé au contexte.

Cette fonction recherche un contexte de prise en charge de chaîne de profil correspondant au contexte spécifié, en fonction de l'identifiant de profil associé au contexte.

Détails
Paramètres
[in] inContext
Référence en lecture seule au contexte de prise en charge de la chaîne de profil à rechercher.
Renvoie
Un pointeur en lecture seule vers la chaîne de profil prend en charge le contexte s'il est trouvé ; sinon, il est NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Permet de rechercher, si elle est enregistrée, les rappels associés à l'identifiant de profil spécifié pour la chaîne de profil.

Détails
Paramètres
[in] inProfileId
Identifiant de profil pour lequel rechercher des rappels de prise en charge de la chaîne.
Renvoie
Un pointeur en lecture seule vers la chaîne de profil accepte des rappels si elle est trouvée ; sinon, elle est NULL.
Voir aussi:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Insérez le contexte de support de la chaîne de profil spécifiée dans le registre.

Cette fonction insère le contexte de prise en charge de la chaîne de profil spécifiée dans le registre, s'il n'est pas déjà présent, dans l'ordre croissant en fonction de l'identifiant de profil croissant.

Détails
Paramètres
[in,out] inOutContext
Référence au contexte de support de la chaîne de profil qui sera insérée dans le registre. Tant que le contexte est présent dans le registre, le champ mNext peut être modifié au fur et à mesure que d'autres contextes sont insérés ou supprimés.
Renvoie
"true" si le contexte a été inséré ; sinon, "false".

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Enregistre les rappels de prise en charge de la chaîne de profil fournie.

Cette fonction enregistre et met à disposition la chaîne de profil fournie prend en charge les rappels.

Détails
Paramètres
[in,out] inOutContext
Référence au contexte de prise en charge de la chaîne de profil qui sera enregistrée et ajoutée au registre. Tant que le contexte est enregistré, le champ mNext peut être modifié à mesure que d'autres contextes sont enregistrés ou non.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Si le contexte est déjà enregistré.
Voir aussi:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Supprimez le contexte de prise en charge de la chaîne de profil spécifiée du registre.

Cette fonction supprime du registre le contexte de prise en charge de la chaîne de profil spécifiée, le cas échéant, en fonction de l'identifiant de profil.

Détails
Paramètres
[in,out] inOutContext
Référence au contexte de support de la chaîne de profil qui sera supprimé, le cas échéant. Lorsque le contexte est supprimé, le champ mNext peut être modifié.
Renvoie
La valeur est "true" si le contexte a été supprimé ; dans le cas contraire, la valeur est "false".

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Annulez l'enregistrement des rappels pris en charge par la chaîne de profil fournie.

Cette fonction annule l'enregistrement et rend indisponible la chaîne de profil fournie qui prend en charge les rappels.

Détails
Paramètres
[in,out] inOutContext
Une référence à la chaîne de profil prend en charge le contexte qui est désenregistré, s'il est enregistré, et qui est supprimé du registre. Lorsque l'enregistrement du contexte est annulé, le champ mNext peut être modifié.
Valeurs de retour
WEAVE_NO_ERROR
Pour la réussite.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Si le contexte n'est pas enregistré.
Voir aussi:
FindStringProfileInfo
RegisterProfielStringInfo