nl:: بافت:: پشتیبانی

خلاصه

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 *
در صورت ثبت نام، رشته نمایه را از تماس های مربوط به شناسه نمایه مشخص شده پشتیبانی کنید.
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:: بافت:: پشتیبانی:: ProfileStringContext

زمینه برای ثبت و لغو ثبت تماس های مربوط به شناسه نمایه مشخص شده برای بازگرداندن رشته های پشتیبانی قابل خواندن توسط انسان مرتبط با نمایه.

nl:: بافت:: پشتیبانی:: ProfileStringInfo

پاسخ‌های تماس مرتبط با شناسه نمایه مشخص شده برای بازگرداندن رشته‌های پشتیبانی قابل خواندن توسط انسان مرتبط با نمایه.

Typedefs

MessageNameFunct

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

Typedef برای یک تابع فراخوانی که یک رشته C پایان‌پذیر NULL قابل خواندن توسط انسان را برمی‌گرداند که نوع پیام مرتبط با شناسه نمایه مشخص‌شده را توصیف می‌کند.

این تماس پس از ثبت، زمانی فراخوانی می‌شود که برای توصیف نوع پیام مرتبط با شناسه نمایه مشخص‌شده، به یک رشته C پایان‌پذیر NULL قابل خواندن برای انسان نیاز باشد.

جزئیات
مولفه های
[in] inProfileId
شناسه نمایه مرتبط با نوع پیام مشخص شده.
[in] inMsgType
نوع پیامی که برای آن یک رشته توصیفی قابل خواندن توسط انسان جستجو می شود.
برمی گرداند
یک اشاره گر به رشته C پایان یافته با NULL در صورت یافتن مطابقت. در غیر این صورت، NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef برای یک تابع فراخوانی که یک رشته C با پایانه NULL قابل خواندن توسط انسان را برمی گرداند و نمایه را با شناسه نمایه مشخص شده توصیف می کند.

این فراخوانی، زمانی که ثبت می‌شود، زمانی فراخوانی می‌شود که برای توصیف نمایه با شناسه نمایه مشخص‌شده، به یک رشته 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
)

در صورت ثبت نام، رشته نمایه را از تماس های مربوط به شناسه نمایه مشخص شده پشتیبانی کنید.

جزئیات
مولفه های
[in] inProfileId
شناسه نمایه برای یافتن تماس‌های پشتیبان رشته.
برمی گرداند
یک اشاره گر فقط خواندنی به رشته نمایه در صورت یافتن، از تماس ها پشتیبانی می کند. در غیر این صورت، NULL.
همچنین ببینید:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

زمینه پشتیبانی رشته پروفایل مشخص شده را در رجیستری وارد کنید.

این تابع، زمینه پشتیبانی رشته پروفایل مشخص شده را به ترتیب مرتب شده، بر اساس شناسه نمایه صعودی، در رجیستری وارد می کند.

جزئیات
مولفه های
[in,out] inOutContext
ارجاع به زمینه پشتیبانی رشته پروفایل که در رجیستری درج خواهد شد. در حالی که زمینه در رجیستری وجود دارد، فیلد mNext ممکن است با درج یا حذف سایر زمینه ها اصلاح شود.
برمی گرداند
درست است اگر زمینه درج شده باشد. در غیر این صورت، نادرست

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 ممکن است اصلاح شود.
برمی گرداند
درست است اگر زمینه حذف شود. در غیر این صورت، نادرست

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

تماس های پشتیبان رشته نمایه ارائه شده را لغو ثبت کنید.

این تابع تماس‌های پشتیبان رشته نمایه ارائه‌شده را لغو ثبت کرده و از دسترس خارج می‌کند.

جزئیات
مولفه های
[in,out] inOutContext
ارجاع به زمینه پشتیبانی رشته نمایه که در صورت ثبت نام ثبت نشده و از رجیستری حذف می شود. وقتی زمینه ثبت نشده باشد، فیلد mNext ممکن است اصلاح شود.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
اگر زمینه ثبت نشده باشد.
همچنین ببینید:
FindStringProfileInfo
RegisterProfielStringInfo