nl::Weave::Support

สรุป

Typedef
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) Typedef
const char *(*
Typedef สำหรับฟังก์ชัน Callback ที่จะแสดงผลสตริง C ที่มีการสิ้นสุด NULL ที่มนุษย์อ่านได้ ซึ่งอธิบายถึงประเภทข้อความที่เชื่อมโยงกับตัวระบุโปรไฟล์ที่ระบุ
ProfileNameFunct)(uint32_t inProfileId) Typedef
const char *(*
Typedef สำหรับฟังก์ชัน Callback ที่จะแสดงผลสตริง C ที่มีการสิ้นสุด NULL ที่มนุษย์อ่านได้ ซึ่งอธิบายถึงโปรไฟล์ด้วยตัวระบุโปรไฟล์ที่ระบุ
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) Typedef
const char *(*
Typedef สำหรับฟังก์ชัน Callback ที่จะแสดงผลสตริง 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
ลงทะเบียน Callback ที่สนับสนุนสตริงโปรไฟล์ที่ระบุ
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
นำบริบทการสนับสนุนสตริงโปรไฟล์ที่ระบุออกจากรีจิสทรี
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
ยกเลิกการลงทะเบียน Callback ที่สนับสนุนสตริงโปรไฟล์ที่ระบุ

โครงสร้าง
nl::Weave::Support::ProfileStringContext

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

nl::Weave::Support::ProfileStringInfo

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

Typedef

MessageNameFunct

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

Typedef สำหรับฟังก์ชัน Callback ที่จะแสดงผลสตริง C ที่มีการสิ้นสุด NULL ที่มนุษย์อ่านได้ ซึ่งอธิบายถึงประเภทข้อความที่เชื่อมโยงกับตัวระบุโปรไฟล์ที่ระบุ

เมื่อลงทะเบียนแล้ว ระบบจะเรียกใช้การเรียกกลับนี้เมื่อจำเป็นต้องใช้สตริง C ที่สิ้นสุดด้วยค่า NULL ที่มนุษย์อ่านได้เพื่ออธิบายประเภทข้อความที่เชื่อมโยงกับตัวระบุโปรไฟล์ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] inProfileId
ตัวระบุโปรไฟล์ที่เชื่อมโยงกับประเภทข้อความที่ระบุ
[in] inMsgType
ประเภทข้อความที่ต้องการค้นหาสตริงคำอธิบายที่มนุษย์อ่านได้
การคืนสินค้า
ตัวชี้ไปยังสตริง C ที่มีการสิ้นสุดเป็นค่าว่างหากพบรายการที่ตรงกัน หากไม่เป็นเช่นนั้น NULL

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef สำหรับฟังก์ชัน Callback ที่จะแสดงผลสตริง C ที่มีการสิ้นสุด NULL ที่มนุษย์อ่านได้ ซึ่งอธิบายถึงโปรไฟล์ด้วยตัวระบุโปรไฟล์ที่ระบุ

เมื่อลงทะเบียนแล้ว ระบบจะเรียกใช้การเรียกกลับนี้เมื่อจำเป็นต้องใช้สตริง C ที่มีการสิ้นสุด NULL ที่มนุษย์อ่านได้เพื่ออธิบายโปรไฟล์ด้วยตัวระบุโปรไฟล์ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] inProfileId
ตัวระบุโปรไฟล์ที่ต้องการค้นหาสตริงคำอธิบายที่มนุษย์อ่านได้
การคืนสินค้า
ตัวชี้ไปยังสตริง C ที่มีการสิ้นสุดเป็นค่าว่างหากพบรายการที่ตรงกัน หากไม่เป็นเช่นนั้น NULL

StatusReportFormatStringFunct

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

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

เมื่อลงทะเบียนแล้ว ระบบจะเรียกใช้การติดต่อกลับนี้เมื่อจำเป็นต้องใช้สตริง C ที่มีการสิ้นสุด NULL ที่มนุษย์อ่านได้เพื่ออธิบายรหัสสถานะที่เชื่อมโยงกับตัวระบุโปรไฟล์ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] inProfileId
ตัวระบุโปรไฟล์ที่เชื่อมโยงกับรหัสสถานะที่ระบุ
[in] inStatusCode
รหัสสถานะที่ต้องการหาสตริงคำอธิบายที่มนุษย์อ่านได้
การคืนสินค้า
ตัวชี้ไปยังสตริง C ที่มีการสิ้นสุดเป็นค่าว่างหากพบรายการที่ตรงกัน หากไม่เป็นเช่นนั้น 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 ถ้ามีการแทรกบริบท หากไม่เป็นเช่นนั้น ให้เป็นเท็จ

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

ลงทะเบียน Callback ที่สนับสนุนสตริงโปรไฟล์ที่ระบุ

ฟังก์ชันนี้จะลงทะเบียนและทำให้สามารถใช้ Callback ที่สนับสนุนสตริงโปรไฟล์ที่ให้มาได้

รายละเอียด
พารามิเตอร์
[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 (จริง) หากบริบทถูกนำออก หากไม่เป็นเช่นนั้น ให้เป็นเท็จ

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

ยกเลิกการลงทะเบียน Callback ที่สนับสนุนสตริงโปรไฟล์ที่ระบุ

ฟังก์ชันนี้จะยกเลิกการลงทะเบียนและทำให้ไม่สามารถใช้ Callback ที่สนับสนุนสตริงโปรไฟล์ที่ให้มา

รายละเอียด
พารามิเตอร์
[in,out] inOutContext
การอ้างอิงบริบทการสนับสนุนสตริงโปรไฟล์ที่จะยกเลิกการลงทะเบียน ลงทะเบียน และนำออกจากรีจิสทรี เมื่อไม่มีการลงทะเบียนบริบท อาจมีการแก้ไขช่อง mNext
ผลลัพธ์
WEAVE_NO_ERROR
สำเร็จแล้ว
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
หากไม่ได้ลงทะเบียนบริบท
โปรดดูเพิ่มเติมที่
FindStringProfileInfo
registerProfielStringInfo