nl::Weave::Support

Ringkasan

Typedef
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef untuk fungsi callback yang menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan jenis pesan yang terkait dengan ID profil yang ditentukan.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef untuk fungsi callback yang menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan mendeskripsikan profil dengan ID profil yang ditentukan.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef untuk fungsi callback yang menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia, yang menjelaskan kode status yang terkait dengan ID profil yang ditentukan.

Variabel
sProfileStringContextHead
Pointer head daftar yang ditautkan secara tunggal dari registry.

Fungsi
FindProfileStringContext(const ProfileStringContext & inContext)
Menemukan konteks dukungan string profil yang cocok dengan konteks yang ditentukan, berdasarkan ID profil yang terkait dengan konteks.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Menemukan, jika terdaftar, string profil mendukung callback yang terkait dengan ID profil yang ditentukan.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Memasukkan konteks dukungan string profil yang ditentukan ke dalam registry.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Mendaftarkan callback dukungan string profil yang disediakan.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Menghapus konteks dukungan string profil yang ditentukan dari registry.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Batalkan pendaftaran callback dukungan string profil yang disediakan.

Struct
nl::Weave::Support::ProfileStringContext

Konteks untuk mendaftarkan dan membatalkan pendaftaran callback yang terkait dengan ID profil yang ditentukan untuk menampilkan string dukungan yang dapat dibaca manusia yang terkait dengan profil.

nl::Weave::Support::ProfileStringInfo

Callback yang terkait dengan ID profil yang ditentukan untuk menampilkan string dukungan yang dapat dibaca manusia yang terkait dengan profil.

Typedef

MessageNameFunct

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

Typedef untuk fungsi callback yang menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan menjelaskan jenis pesan yang terkait dengan ID profil yang ditentukan.

Callback ini, saat terdaftar, akan dipanggil saat string C yang diakhiri dengan NULL yang dapat dibaca manusia diperlukan untuk mendeskripsikan jenis pesan yang terkait dengan ID profil yang ditentukan.

Detail
Parameter
[in] inProfileId
ID profil yang terkait dengan jenis pesan yang ditentukan.
[in] inMsgType
Jenis pesan yang dicari dengan string deskriptif yang dapat dibaca manusia.
Hasil
sebuah pointer ke {i>string<i} C yang diakhiri dengan NULL jika ditemukan kecocokan; jika tidak, maka akan menjadi NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef untuk fungsi callback yang menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia dan mendeskripsikan profil dengan ID profil yang ditentukan.

Callback ini, saat terdaftar, akan dipanggil saat string C yang diakhiri dengan NULL yang dapat dibaca manusia diperlukan untuk mendeskripsikan profil dengan ID profil yang ditentukan.

Detail
Parameter
[in] inProfileId
ID profil yang mencari string deskriptif yang dapat dibaca manusia.
Hasil
sebuah pointer ke {i>string<i} C yang diakhiri dengan NULL jika ditemukan kecocokan; jika tidak, maka akan menjadi NULL.

StatusReportFormatStringFunct

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

Typedef untuk fungsi callback yang menampilkan string C yang diakhiri dengan NULL yang dapat dibaca manusia, yang menjelaskan kode status yang terkait dengan ID profil yang ditentukan.

Callback ini, saat terdaftar, akan dipanggil saat string C yang diakhiri dengan NULL yang dapat dibaca manusia diperlukan untuk mendeskripsikan kode status yang terkait dengan ID profil yang ditentukan.

Detail
Parameter
[in] inProfileId
ID profil yang terkait dengan kode status yang ditentukan.
[in] inStatusCode
Kode status yang mencari string deskriptif yang dapat dibaca manusia.
Hasil
sebuah pointer ke {i>string<i} C yang diakhiri dengan NULL jika ditemukan kecocokan; jika tidak, maka akan menjadi NULL.

Variabel

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Pointer head daftar yang ditautkan secara tunggal dari registry.

Fungsi

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Menemukan konteks dukungan string profil yang cocok dengan konteks yang ditentukan, berdasarkan ID profil yang terkait dengan konteks.

Fungsi ini menemukan konteks dukungan string profil yang cocok dengan konteks yang ditentukan, berdasarkan ID profil yang terkait dengan konteks.

Detail
Parameter
[in] inContext
Referensi hanya baca ke konteks dukungan string profil yang akan ditemukan.
Hasil
pointer hanya-baca ke konteks dukungan string profil jika ditemukan; jika tidak, maka akan menjadi NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Menemukan, jika terdaftar, string profil mendukung callback yang terkait dengan ID profil yang ditentukan.

Detail
Parameter
[in] inProfileId
ID profil untuk menemukan callback dukungan string.
Hasil
pointer hanya-baca ke callback dukungan string profil jika ditemukan; jika tidak, maka akan menjadi NULL.
Lihat juga:
RegisterProfielStringInfo
RegistrationProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Memasukkan konteks dukungan string profil yang ditentukan ke dalam registry.

Fungsi ini menyisipkan konteks dukungan string profil yang ditentukan ke dalam registry, jika belum ada, dalam urutan yang diurutkan, berdasarkan ID profil menaik.

Detail
Parameter
[in,out] inOutContext
Referensi ke konteks dukungan string profil yang akan disisipkan ke dalam registry. Meskipun konteks ada dalam registry, kolom mNext dapat diubah saat konteks lain disisipkan atau dihapus.
Hasil
{i>true<i} jika konteks dimasukkan; jika tidak, salah (false).

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Mendaftarkan callback dukungan string profil yang disediakan.

Fungsi ini mendaftarkan dan menyediakan callback dukungan string profil yang disediakan.

Detail
Parameter
[in,out] inOutContext
Referensi ke konteks dukungan string profil yang akan didaftarkan dan ditambahkan ke registry. Saat konteks didaftarkan, kolom mNext dapat diubah saat konteks lain didaftarkan atau dibatalkan pendaftarannya.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Jika konteks sudah terdaftar.
Lihat juga:
FindStringProfileInfo
RegistrationProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Menghapus konteks dukungan string profil yang ditentukan dari registry.

Fungsi ini menghapus konteks dukungan string profil yang ditentukan dari registry, jika ada, berdasarkan ID profil.

Detail
Parameter
[in,out] inOutContext
Referensi ke konteks dukungan string profil yang akan dihapus, jika ada. Jika konteks dihapus, kolom mNext dapat diubah.
Hasil
{i>true<i} jika konteksnya dihapus; jika tidak, salah (false).

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Batalkan pendaftaran callback dukungan string profil yang disediakan.

Fungsi ini membatalkan pendaftaran dan membuat callback dukungan string profil yang disediakan tidak tersedia.

Detail
Parameter
[in,out] inOutContext
Referensi ke konteks dukungan string profil yang akan dibatalkan pendaftarannya, jika didaftarkan, dan dihapus dari registry. Jika konteks tidak terdaftar, kolom mNext dapat diubah.
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Berhasil.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Jika konteks tidak terdaftar.
Lihat juga:
FindStringProfileInfo
RegisterProfielStringInfo