nl::Weave::Support

סיכום

ערכי דף
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

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

nl::Weave::Support::ProfileStringInfo

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

ערכי דף

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, המתארת את קוד הסטטוס המשויך למזהה הפרופיל שצוין.

הקריאה החוזרת, כשהיא רשומה, מופעלת כאשר יש צורך במחרוזת 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) אם נמצאו. אחרת, הערך 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
רישוםProfielStringInfo