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 par l'utilisateur et 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 *(*
Définition de type pour une fonction de rappel qui renvoie une chaîne C lisible par l'utilisateur et 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 par l'utilisateur et se terminant par une valeur NULL décrivant le code d'état associé à l'identifiant de profil spécifié.

Variables
sProfileStringContextHead
Pointeur principal de la liste à lien unique du registre.

Fonctions
FindProfileStringContext(const ProfileStringContext & inContext)
Recherchez un contexte compatible avec 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 *
Recherchez, si elle est enregistrée, la chaîne de profil accepte les rappels associés à l'identifiant de profil spécifié.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Insérez le contexte de prise en charge de la chaîne de profil spécifiée dans le registre.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Enregistrez les rappels de prise en charge de la chaîne de profil fournie.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Supprimez du registre le contexte de compatibilité de la chaîne de profil spécifiée.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Annulez l'enregistrement de la chaîne de profil fournie pour prendre en charge les rappels.

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 les chaînes d'assistance lisibles 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 par l'utilisateur et se terminant par une valeur NULL décrivant le type de message associé à l'identifiant de profil spécifié.

Ce rappel, une fois enregistré, est invoqué lorsqu'une chaîne C lisible par l'utilisateur doit être clôturée par une valeur NULL 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'humain est recherchée.
Renvoie
un pointeur vers la chaîne C arrêtée par la valeur NULL si une correspondance est trouvée ; sinon NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

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

Ce rappel, une fois enregistré, est invoqué lorsqu'une chaîne C lisible par l'utilisateur et clôturée 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'humain est recherchée.
Renvoie
un pointeur vers la chaîne C arrêtée par la valeur NULL si une correspondance est trouvée ; sinon NULL.

StatusReportFormatStringFunct

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

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

Ce rappel, une fois enregistré, est invoqué lorsqu'une chaîne C se terminant par une valeur NULL lisible par l'humain 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'humain est recherchée.
Renvoie
un pointeur vers la chaîne C arrêtée par la valeur NULL si une correspondance est trouvée ; sinon NULL.

Variables

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Pointeur principal de la liste à lien unique du registre.

Fonctions

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Recherchez un contexte compatible avec 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 compatible avec la 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 à la chaîne de profil compatible avec la recherche.
Renvoie
Un pointeur en lecture seule vers le contexte de prise en charge de la chaîne de profil s'il est trouvé sinon NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

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

Détails
Paramètres
[in] inProfileId
Identifiant de profil pour lequel rechercher des rappels de prise en charge des chaînes.
Renvoie
Un pointeur en lecture seule vers la chaîne de profil prend en charge les rappels s'il est trouvé. sinon NULL.
Voir aussi:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

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

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

Détails
Paramètres
[in,out] inOutContext
Référence au contexte de prise en charge 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é lorsque d'autres contextes sont insérés ou supprimés.
Renvoie
La valeur est "true" si le contexte a été inséré. sinon, "false".

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

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

Cette fonction enregistre et met à disposition les rappels compatibles avec la chaîne de profil fournie.

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. Pendant l'enregistrement du contexte, le champ "mNext" peut être modifié à mesure que d'autres contextes sont enregistrés ou non.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de 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 du registre le contexte de compatibilité de la chaîne de profil spécifiée.

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

Détails
Paramètres
[in,out] inOutContext
Référence au contexte de prise en charge 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é. sinon, "false".

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Annulez l'enregistrement de la chaîne de profil fournie pour prendre en charge les rappels.

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

Détails
Paramètres
[in,out] inOutContext
Référence au contexte de prise en charge de la chaîne de profil qui sera annulée, si elle est enregistrée, puis supprimée du registre. Lorsque l'enregistrement du contexte est annulé, le champ "mNext" peut être modifié.
Valeurs renvoyées
WEAVE_NO_ERROR
En cas de réussite.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Si le contexte n'est pas enregistré.
Voir aussi:
FindStringProfileInfo
RegisterProfielStringInfo