nl::Weave::Support

סיכום

Typedefs
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef עבור פונקציית קריאה חוזרת שמחזירה מחרוזת C המסוגלת לקרוא אנשים מסוג NULL, המתארת את סוג ההודעה המשויכת למזהה הפרופיל שצוין.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef לפונקציית קריאה חוזרת המחזירה מחרוזת C שסומנה על ידי NULL, המוגדרת לאנשים, ומתארת את הפרופיל עם מזהה הפרופיל שצוין.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef עבור פונקציית קריאה חוזרת שמחזירה מחרוזת C המסוגלת לקרוא אנשים מסוג NULL, המתארת את קוד הסטטוס המשויך למזהה הפרופיל שצוין.

משתנים
sProfileStringContextHead
מצביע על ראש רשימה שמקושרת בנפרד למרשם.

פונקציות
FindProfileStringContext(const ProfileStringContext & inContext)
חיפוש של מחרוזת פרופיל שמכילה הקשר שתואם להקשר שצוין, על סמך מזהה הפרופיל שמשויך להקשר.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
אם היא רשומה, היא תומכת בקריאות חוזרות (callback) שמשויכות למזהה הפרופיל שצוין.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
הוספת הקשר התמיכה של מחרוזת הפרופיל שצוינה למרשם.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
רישום הקריאות החוזרות לתמיכה במחרוזת הפרופיל שסופקה.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
צריך להסיר מהמרשם את הקשר התמיכה של מחרוזת הפרופיל שצוינה.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
ביטול הרישום של מחרוזת הפרופיל שסופקה עם קריאות חוזרות לתמיכה.

מבנים
nl::Weave::Support::ProfileStringContext

הקשר לרישום ולביטול רישום של קריאות חוזרות (callback) שמשויכות למזהה הפרופיל שצוין, לצורך החזרת מחרוזות תמיכה שניתנות לקריאה על ידי אנשים שמשויכים לפרופיל.

nl::Weave::Support::ProfileStringInfo

קריאות חוזרות (callback) המשויכות למזהה הפרופיל שצוין, לצורך החזרת מחרוזות תמיכה שניתנות לקריאה על ידי אנשים ומשויכות לפרופיל.

Typedefs

MessageNameFunct

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

Typedef עבור פונקציית קריאה חוזרת שמחזירה מחרוזת C המסוגלת לקרוא אנשים מסוג NULL, המתארת את סוג ההודעה המשויכת למזהה הפרופיל שצוין.

הקריאה החוזרת (callback) הזו, בעת הרישום, מופעלת כשדרושה מחרוזת C שסומנה ב-NULL, שקריאה לאנשים כדי לתאר את סוג ההודעה שמשויך למזהה הפרופיל שצוין.

פרטים
פרמטרים
[in] inProfileId
מזהה הפרופיל שמשויך לסוג ההודעה שצוין.
[in] inMsgType
סוג ההודעה שבשבילה יש לחפש מחרוזת תיאורית שאנשים יכולים לקרוא.
החזרות
מצביע למחרוזת C עם סיום NULL אם נמצאה התאמה; אחרת, הערך NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef עבור פונקציית קריאה חוזרת שמחזירה מחרוזת C המסוגלת לקרוא אנשים מסוג NULL, המתארת את הפרופיל עם מזהה הפרופיל שצוין.

הקריאה החוזרת (callback) הזו, כאשר הרישום מתבצעת, מופעלת כשדרושה מחרוזת C שסומנה ב-NULL, שאנשים יכולים לקרוא, כדי לתאר את הפרופיל עם מזהה הפרופיל שצוין.

פרטים
פרמטרים
[in] inProfileId
מזהה הפרופיל שעבורו יש לחפש מחרוזת תיאורית לקריאה לאנשים.
החזרות
מצביע למחרוזת C עם סיום NULL אם נמצאה התאמה; אחרת, הערך NULL.

StatusReportFormatStringFunct

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

Typedef לפונקציית קריאה חוזרת המחזירה מחרוזת C שסומנה על ידי NULL, המוגדרת לאנשים, ומתארת את קוד הסטטוס המשויך למזהה הפרופיל שצוין.

הקריאה החוזרת (callback) הזו, בעת הרישום, מופעלת כשדרושה מחרוזת C שסומנה ב-NULL, שקריאה לאנשים כדי לתאר את קוד הסטטוס שמשויך למזהה הפרופיל שצוין.

פרטים
פרמטרים
[in] inProfileId
מזהה הפרופיל שמשויך לקוד הסטטוס שצוין.
[in] inStatusCode
קוד הסטטוס שעבורו יש להשתמש במחרוזת תיאורית שאנשים יכולים לקרוא.
החזרות
מצביע למחרוזת C עם סיום NULL אם נמצאה התאמה; אחרת, הערך NULL.

משתנים

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

מצביע על ראש רשימה שמקושרת בנפרד למרשם.

פונקציות

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

חיפוש של מחרוזת פרופיל שמכילה הקשר שתואם להקשר שצוין, על סמך מזהה הפרופיל שמשויך להקשר.

הפונקציה מוצאת מחרוזת פרופיל שמכילה הקשר שתואם להקשר שצוין, על סמך מזהה הפרופיל שמשויך להקשר.

פרטים
פרמטרים
[in] inContext
הפניה לקריאה בלבד של מחרוזת הפרופיל בהקשר של תמיכה באיתור.
החזרות
מצביע לקריאה בלבד למחרוזת הפרופיל לתמיכה בהקשר, אם נמצא. אחרת, הערך NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

אם היא רשומה, היא תומכת בקריאות חוזרות (callback) שמשויכות למזהה הפרופיל שצוין.

פרטים
פרמטרים
[in] inProfileId
מזהה הפרופיל שצריך למצוא בשבילו קריאות חוזרות (callback) לתמיכה במחרוזת.
החזרות
מצביע לקריאה בלבד למחרוזת הפרופיל, אם הוא נמצא תומך בקריאות חוזרות (callback) אחרת, הערך NULL.
למידע נוסף:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

הוספת הקשר התמיכה של מחרוזת הפרופיל שצוינה למרשם.

הפונקציה הזו מוסיפה למרשם את הקשר התמיכה של מחרוזת הפרופיל שצוינה, אם היא לא קיימת, בסדר ממוין, לפי מזהה הפרופיל עולה.

פרטים
פרמטרים
[in,out] inOutContext
הפניה להקשר התמיכה של מחרוזת הפרופיל שתוכנס למרשם. אמנם ההקשר קיים במרשם, אבל ניתן לשנות את השדה mNext לפי הוספה או הסרה של הקשרים אחרים.
החזרות
true אם ההקשר נוסף; אחרת, false.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

רישום הקריאות החוזרות לתמיכה במחרוזת הפרופיל שסופקה.

הפונקציה הזו רושמת והופכת את הקריאות החוזרות לתמיכה במחרוזת הפרופיל שסופקה.

פרטים
פרמטרים
[in,out] inOutContext
הפניה להקשר התמיכה של מחרוזת הפרופיל שתירשם ותתווסף למרשם. בזמן שההקשר רשום, יכול להיות ששדה mNext ישתנה כי הקשרים אחרים נרשמים או לא רשומים.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
אם ההקשר כבר רשום.
למידע נוסף:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

צריך להסיר מהמרשם את הקשר התמיכה של מחרוזת הפרופיל שצוינה.

הפונקציה הזו מסירה מהמרשם את הקשר התמיכה של מחרוזת הפרופיל שצוינה, אם יש כזו, על סמך מזהה הפרופיל.

פרטים
פרמטרים
[in,out] inOutContext
הפניה להקשר התמיכה של מחרוזת הפרופיל שיוסר, אם יש כזו. לאחר הסרת ההקשר, אפשר לשנות את השדה mNext.
החזרות
true אם ההקשר הוסר; אחרת, false.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

ביטול הרישום של מחרוזת הפרופיל שסופקה עם קריאות חוזרות לתמיכה.

הפונקציה הזו מבטלת את הרישום ולא מאפשרת להשתמש בקריאות חוזרות (callback) לתמיכה במחרוזת הפרופיל שסופקה.

פרטים
פרמטרים
[in,out] inOutContext
הפניה להקשר התמיכה של מחרוזת הפרופיל שהרישום שלה יבוטל, אם היא תירשם ותוסר מהמרשם. לאחר ביטול הרישום של ההקשר, ניתן יהיה לשנות את השדה mNext.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
אם ההקשר לא רשום.
למידע נוסף:
FindStringProfileInfo
RegisterProfielStringInfo