nl::Weave::Support

Özet

Typedef'ler
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Belirtilen profil tanımlayıcısıyla ilişkili mesaj türünü açıklayan, okunabilir NULL sonlu bir C dizesi döndüren geri çağırma işlevi için typedef.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Belirtilen profil tanımlayıcısıyla profili açıklayan, kullanıcıların okuyabileceği NULL sonlu bir C dizesi döndüren geri çağırma işlevi için typedef.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Belirtilen profil tanımlayıcısıyla ilişkili durum kodunu açıklayan, kullanıcıların okuyabileceği NULL sonlu bir C dizesi döndüren geri çağırma işlevi için typedef.

Değişkenler
sProfileStringContextHead
Kayıt defteri tek başına bağlantılı liste başlığı işaretçisi.

İşlevler
FindProfileStringContext(const ProfileStringContext & inContext)
Bağlamla ilişkilendirilen profil tanımlayıcısına göre, belirtilen bağlamla eşleşen bir profil dizesi destek bağlamını bulun.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Kayıtlıysa, profil dizesinin belirtilen profil tanımlayıcısıyla ilişkilendirilmiş geri çağırmaları desteklediğini bulun.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Belirtilen profil dizesi destek bağlamını kayıt defterine ekleyin.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Sağlanan profil dizesi destek geri çağırmalarını kaydedin.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Belirtilen profil dizesi destek bağlamını kayıt defterinden kaldırın.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Sağlanan profil dizesi destek geri çağırmalarının kaydını silin.

Yapılar
nl::Weave::Support::ProfileStringContext

Profille ilişkili kullanıcılar tarafından okunabilir destek dizelerini döndürmek için belirtilen profil tanımlayıcısıyla ilişkili geri çağırmaların kaydedilmesi ve kaydının silinmesi ile ilgili bağlam.

nl::Weave::Support::ProfileStringInfo

Profille ilişkili, okunabilir destek dizelerini döndürmek için belirtilen profil tanımlayıcısıyla ilişkili geri çağırmalar.

Typedef'ler

MessageNameFunct

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

Belirtilen profil tanımlayıcısıyla ilişkili mesaj türünü açıklayan, okunabilir NULL sonlu bir C dizesi döndüren geri çağırma işlevi için typedef.

Bu geri çağırma, kaydedildiğinde, belirtilen profil tanımlayıcısıyla ilişkili mesaj türünü açıklamak için insan tarafından okunabilen NULL sonlu bir C dizesi gerektiğinde çağrılır.

Ayrıntılar
Parametreler
[in] inProfileId
Belirtilen mesaj türüyle ilişkili profil tanımlayıcısı.
[in] inMsgType
Kullanıcıların okuyabileceği açıklayıcı bir dizenin arandığı mesaj türü.
İadeler
eşleşme bulunursa NULL sonlu C dizesine işaret eden bir işaret; Aksi takdirde, NULL olacaktır.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Belirtilen profil tanımlayıcısıyla profili açıklayan, kullanıcıların okuyabileceği NULL sonlu bir C dizesi döndüren geri çağırma işlevi için typedef.

Bu geri çağırma, kaydedildiğinde, profili belirtilen profil tanımlayıcısıyla tanımlamak için insan tarafından okunabilen NULL sonlu bir C dizesi gerektiğinde çağrılır.

Ayrıntılar
Parametreler
[in] inProfileId
Kullanıcıların okuyabileceği açıklayıcı bir dizenin arandığı profil tanımlayıcısı.
İadeler
eşleşme bulunursa NULL sonlu C dizesine işaret eden bir işaret; Aksi takdirde, NULL olacaktır.

StatusReportFormatStringFunct

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

Belirtilen profil tanımlayıcısıyla ilişkili durum kodunu açıklayan, kullanıcıların okuyabileceği NULL sonlu bir C dizesi döndüren geri çağırma işlevi için typedef.

Bu geri çağırma, kaydedildiğinde, belirtilen profil tanımlayıcısıyla ilişkili durum kodunu açıklamak için insan tarafından okunabilen NULL sonlu bir C dizesi gerektiğinde çağrılır.

Ayrıntılar
Parametreler
[in] inProfileId
Belirtilen durum koduyla ilişkili profil tanımlayıcısı.
[in] inStatusCode
Kullanıcıların okuyabileceği açıklayıcı bir dizenin arandığı durum kodu.
İadeler
eşleşme bulunursa NULL sonlu C dizesine işaret eden bir işaret; Aksi takdirde, NULL olacaktır.

Değişkenler

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Kayıt defteri tek başına bağlantılı liste başlığı işaretçisi.

İşlevler

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Bağlamla ilişkilendirilen profil tanımlayıcısına göre, belirtilen bağlamla eşleşen bir profil dizesi destek bağlamını bulun.

Bu işlev, bağlamla ilişkilendirilen profil tanımlayıcısına göre belirtilen içerikle eşleşen bir profil dizesi destek bağlamı bulur.

Ayrıntılar
Parametreler
[in] inContext
Bulunacak profil dizesi destek bağlamına yönelik salt okunur referans.
İadeler
bulunursa profil dizesi destek bağlamına salt okunur bir işaretçi ekler; Aksi takdirde, NULL olacaktır.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Kayıtlıysa, profil dizesinin belirtilen profil tanımlayıcısıyla ilişkilendirilmiş geri çağırmaları desteklediğini bulun.

Ayrıntılar
Parametreler
[in] inProfileId
Dize desteği geri çağırmalarının bulunacağı profil tanımlayıcısı.
İadeler
bulunursa, profil dizesi destek geri çağırmaları için salt okunur bir işaretçi içerir; Aksi takdirde, NULL olacaktır.
Ayrıca bkz:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Belirtilen profil dizesi destek bağlamını kayıt defterine ekleyin.

Bu işlev, belirtilen profil dizesi destek bağlamını, daha önce yoksa, artan profil tanımlayıcısına göre sıralanmış şekilde kayıt defterine ekler.

Ayrıntılar
Parametreler
[in,out] inOutContext
Kayıt defterine eklenecek profil dizesi destek bağlamına başvuru. Bağlam kayıt defterinde mevcutken, diğer bağlamlar eklendikçe veya kaldırıldıkça mNext alanı değiştirilebilir.
İadeler
bağlam eklendiyse true; Aksi takdirde, false'tur.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Sağlanan profil dizesi destek geri çağırmalarını kaydedin.

Bu işlev, sağlanan profil dizesi destek geri çağırmalarını kaydeder ve kullanılabilir hale getirir.

Ayrıntılar
Parametreler
[in,out] inOutContext
Kaydedilecek ve kayıt defterine eklenecek profil dizesi destek bağlamına yönelik bir referans. Bağlam kaydedilirken diğer bağlamlar kaydedildiğinde veya kaydı iptal edildiğinde mNext alanı değiştirilebilir.
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Bağlam zaten kayıtlıysa.
Ayrıca bkz:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Belirtilen profil dizesi destek bağlamını kayıt defterinden kaldırın.

Bu işlev, belirtilen profil dizesi destek bağlamını (varsa), profil tanımlayıcısına göre kayıt defterinden kaldırır.

Ayrıntılar
Parametreler
[in,out] inOutContext
Varsa kaldırılacak profil dizesi destek bağlamına referans. Bağlam kaldırıldığında mNext alanı değiştirilebilir.
İadeler
bağlam kaldırıldıysa true; Aksi takdirde, false'tur.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Sağlanan profil dizesi destek geri çağırmalarının kaydını silin.

Bu işlev, sağlanan profil dizesi destek geri çağırmalarının kaydını siler ve kullanılamaz hale getirir.

Ayrıntılar
Parametreler
[in,out] inOutContext
Kayıtlı olması halinde kaydı iptal edilecek ve kayıt otoritesinden kaldırılacak profil dizesi destek bağlamına yönelik bir referans. Bağlamın kaydı iptal edildiğinde mNext alanı değiştirilebilir.
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Bağlamın kayıtlı olup olmadığı.
Ayrıca bkz:
FindStringProfileInfo
RegisterProfielStringInfo