nl::Weave::Support

Tóm tắt

Typedef
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef cho hàm callback trả về một chuỗi C kết thúc NULL mà con người có thể đọc được, mô tả loại thông báo liên kết với giá trị nhận dạng cấu hình được chỉ định.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef cho hàm callback trả về một chuỗi C kết thúc NULL mà con người có thể đọc được, dùng để mô tả hồ sơ có giá trị nhận dạng hồ sơ được chỉ định.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef cho hàm callback trả về một chuỗi C kết thúc NULL mà con người có thể đọc được, mô tả mã trạng thái được liên kết với giá trị nhận dạng cấu hình được chỉ định.

Biến
sProfileStringContextHead
Con trỏ đầu danh sách liên kết đơn của sổ đăng ký.

Hàm
FindProfileStringContext(const ProfileStringContext & inContext)
Tìm ngữ cảnh hỗ trợ chuỗi hồ sơ khớp với ngữ cảnh được chỉ định, dựa trên giá trị nhận dạng hồ sơ được liên kết với ngữ cảnh.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Tìm (nếu đã đăng ký) chuỗi hồ sơ hỗ trợ lệnh gọi lại liên kết với giá trị nhận dạng hồ sơ đã chỉ định.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Chèn ngữ cảnh hỗ trợ chuỗi hồ sơ đã chỉ định vào sổ đăng ký.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Đăng ký các lệnh gọi lại hỗ trợ chuỗi hồ sơ đã cung cấp.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Xoá ngữ cảnh hỗ trợ chuỗi hồ sơ đã chỉ định khỏi sổ đăng ký.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Huỷ đăng ký các lệnh gọi lại hỗ trợ chuỗi hồ sơ đã cung cấp.

Cấu trúc
nl::Weave::Support::ProfileStringContext

Bối cảnh để đăng ký và huỷ đăng ký lệnh gọi lại liên kết với giá trị nhận dạng hồ sơ đã chỉ định để trả về chuỗi hỗ trợ mà con người có thể đọc được được liên kết với hồ sơ.

nl::Weave::Support::ProfileStringInfo

Lệnh gọi lại được liên kết với giá trị nhận dạng hồ sơ đã chỉ định để trả về chuỗi hỗ trợ mà con người có thể đọc được được liên kết với hồ sơ.

Typedef

MessageNameFunct

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

Typedef cho hàm callback trả về một chuỗi C kết thúc NULL mà người dùng có thể đọc được, mô tả loại thông báo liên kết với giá trị nhận dạng cấu hình được chỉ định.

Sau khi được đăng ký, lệnh gọi lại này sẽ được gọi khi cần có một chuỗi C kết thúc bằng giá trị NULL (NULL) mà người dùng có thể đọc được để mô tả loại thông báo liên kết với giá trị nhận dạng hồ sơ đã chỉ định.

Thông tin chi tiết
Tham số
[in] inProfileId
Mã nhận dạng hồ sơ được liên kết với loại thông báo đã chỉ định.
[in] inMsgType
Loại thông báo mà người dùng cần có chuỗi mô tả dễ đọc.
Trả về
một con trỏ tới chuỗi C kết thúc bằng giá trị NULL nếu tìm thấy kết quả trùng khớp; nếu không thì là NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef cho hàm callback trả về một chuỗi C kết thúc NULL mà con người có thể đọc được, mô tả hồ sơ có giá trị nhận dạng hồ sơ được chỉ định.

Khi được đăng ký, lệnh gọi lại này sẽ được gọi khi cần có một chuỗi C kết thúc bằng giá trị NULL (Rỗng) mà con người có thể đọc được để mô tả hồ sơ bằng giá trị nhận dạng hồ sơ đã chỉ định.

Thông tin chi tiết
Tham số
[in] inProfileId
Giá trị nhận dạng hồ sơ mà con người tìm kiếm chuỗi mô tả có thể đọc được.
Trả về
một con trỏ tới chuỗi C kết thúc bằng giá trị NULL nếu tìm thấy kết quả trùng khớp; nếu không thì là NULL.

StatusReportFormatStringFunct

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

Typedef cho hàm callback trả về một chuỗi C kết thúc NULL mà con người có thể đọc được, mô tả mã trạng thái được liên kết với giá trị nhận dạng cấu hình được chỉ định.

Khi được đăng ký, lệnh gọi lại này sẽ được gọi khi cần có một chuỗi C kết thúc bằng giá trị NULL (Rỗng) mà con người có thể đọc được để mô tả mã trạng thái liên kết với giá trị nhận dạng cấu hình đã chỉ định.

Thông tin chi tiết
Tham số
[in] inProfileId
Mã nhận dạng hồ sơ được liên kết với mã trạng thái đã chỉ định.
[in] inStatusCode
Mã trạng thái mà con người tìm kiếm chuỗi mô tả có thể đọc được.
Trả về
một con trỏ tới chuỗi C kết thúc bằng giá trị NULL nếu tìm thấy kết quả trùng khớp; nếu không thì là NULL.

Biến

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Con trỏ đầu danh sách liên kết đơn của sổ đăng ký.

Hàm

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Tìm ngữ cảnh hỗ trợ chuỗi hồ sơ khớp với ngữ cảnh được chỉ định, dựa trên giá trị nhận dạng hồ sơ được liên kết với ngữ cảnh.

Hàm này tìm một ngữ cảnh hỗ trợ chuỗi hồ sơ khớp với ngữ cảnh đã chỉ định, dựa trên giá trị nhận dạng hồ sơ được liên kết với ngữ cảnh.

Thông tin chi tiết
Tham số
[in] inContext
Tham chiếu chỉ đọc đến ngữ cảnh hỗ trợ chuỗi hồ sơ cần tìm.
Trả về
con trỏ chỉ đọc đến ngữ cảnh hỗ trợ chuỗi hồ sơ (nếu có); nếu không thì là NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Tìm (nếu đã đăng ký) chuỗi hồ sơ hỗ trợ lệnh gọi lại liên kết với giá trị nhận dạng hồ sơ đã chỉ định.

Thông tin chi tiết
Tham số
[in] inProfileId
Giá trị nhận dạng hồ sơ để tìm lệnh gọi lại hỗ trợ chuỗi.
Trả về
con trỏ chỉ đọc đến chuỗi hồ sơ hỗ trợ các lệnh gọi lại (nếu có); nếu không thì là NULL.
Xem thêm:
Đăng kýProfielStringInfo
Huỷ đăng kýProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Chèn ngữ cảnh hỗ trợ chuỗi hồ sơ đã chỉ định vào sổ đăng ký.

Hàm này sẽ chèn ngữ cảnh hỗ trợ chuỗi hồ sơ đã chỉ định vào sổ đăng ký (nếu chưa có) theo thứ tự được sắp xếp dựa trên giá trị nhận dạng hồ sơ tăng dần.

Thông tin chi tiết
Tham số
[in,out] inOutContext
Tham chiếu tới ngữ cảnh hỗ trợ chuỗi hồ sơ sẽ được chèn vào sổ đăng ký. Mặc dù ngữ cảnh có trong sổ đăng ký, nhưng trường mNext có thể được sửa đổi khi các ngữ cảnh khác được chèn hoặc xoá.
Trả về
true nếu ngữ cảnh được chèn vào; ngược lại sẽ là false.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Đăng ký các lệnh gọi lại hỗ trợ chuỗi hồ sơ đã cung cấp.

Hàm này đăng ký và cung cấp các lệnh gọi lại hỗ trợ chuỗi hồ sơ được cung cấp.

Thông tin chi tiết
Tham số
[in,out] inOutContext
Tham chiếu đến ngữ cảnh hỗ trợ chuỗi hồ sơ sẽ được đăng ký và thêm vào sổ đăng ký. Trong khi ngữ cảnh được đăng ký, trường mNext có thể được sửa đổi khi các ngữ cảnh khác đã được đăng ký hoặc chưa được đăng ký.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Nếu bối cảnh đã được đăng ký.
Xem thêm:
FindStringProfileInfo
Huỷ đăng kýProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Xoá ngữ cảnh hỗ trợ chuỗi hồ sơ đã chỉ định khỏi sổ đăng ký.

Hàm này sẽ xoá ngữ cảnh hỗ trợ chuỗi hồ sơ đã chỉ định khỏi sổ đăng ký (nếu có) dựa trên giá trị nhận dạng hồ sơ.

Thông tin chi tiết
Tham số
[in,out] inOutContext
Thông tin tham chiếu đến ngữ cảnh hỗ trợ chuỗi hồ sơ sẽ bị xoá, nếu có. Khi ngữ cảnh bị xoá, trường mNext có thể sẽ được sửa đổi.
Trả về
true nếu ngữ cảnh đã bị xoá; ngược lại sẽ là false.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Huỷ đăng ký các lệnh gọi lại hỗ trợ chuỗi hồ sơ đã cung cấp.

Hàm này huỷ đăng ký và ngừng cung cấp các lệnh gọi lại hỗ trợ chuỗi hồ sơ đã cung cấp.

Thông tin chi tiết
Tham số
[in,out] inOutContext
Mục tham chiếu đến ngữ cảnh hỗ trợ chuỗi hồ sơ sẽ bị huỷ đăng ký nếu đã đăng ký và bị xoá khỏi sổ đăng ký. Khi bối cảnh bị huỷ đăng ký, trường mNext có thể sẽ được sửa đổi.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Nếu bối cảnh chưa được đăng ký.
Xem thêm:
FindStringProfileInfo
LoginProfielStringInfo