nl::Weave::Support

สรุป

Typedef

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::Weave::Support::ProfileStringContext

บริบทสำหรับการลงทะเบียนและยกเลิกการลงทะเบียนโค้ดเรียกกลับที่เชื่อมโยงกับตัวระบุโปรไฟล์ที่ระบุไว้ สำหรับการแสดงสตริงสนับสนุนที่มนุษย์อ่านได้ซึ่งเชื่อมโยงกับโปรไฟล์นั้น

nl::Weave::Support::ProfileStringInfo

โค้ดเรียกกลับที่เชื่อมโยงกับตัวระบุโปรไฟล์ที่ระบุสำหรับการแสดงสตริงสนับสนุนที่มนุษย์อ่านได้ซึ่งเชื่อมโยงกับโปรไฟล์

Typedef

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 เมื่อมีการแทรกหรือนําบริบทอื่นๆ ออก
การส่งคืน
true หากมีการแทรกบริบทไว้ มิเช่นนั้นให้เป็นเท็จ

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