nl::Weave::Support

Podsumowanie

Definiuje typ
MessageNameFunct)(uint32_t inProfileId, uint8_t inMsgType) typedef
const char *(*
Typedef to funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C z zakończeniem NULL i opisujący typ wiadomości powiązany z określonym identyfikatorem profilu.
ProfileNameFunct)(uint32_t inProfileId) typedef
const char *(*
Typedef to funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C z zakończeniem NULL i opisujący profil o określonym identyfikatorze.
StatusReportFormatStringFunct)(uint32_t inProfileId, uint16_t inStatusCode) typedef
const char *(*
Typedef to funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C z zakończeniem NULL i opisujący kod stanu powiązany z określonym identyfikatorem profilu.

Zmienne
sProfileStringContextHead
Wskaźnik nagłówka listy połączonej pojedynczo z rejestrem.

Funkcje
FindProfileStringContext(const ProfileStringContext & inContext)
Znajdź ciąg profilu obsługujący kontekst pasujący do określonego kontekstu na podstawie identyfikatora profilu powiązanego z kontekstem.
FindProfileStringInfo(uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Znajdź, jeśli ciąg profilu jest zarejestrowany, obsługuje wywołania zwrotne powiązane z określonym identyfikatorem profilu.
InsertProfileStringContext(ProfileStringContext & inOutContext)
bool
Wstaw do rejestru kontekst obsługi podanego ciągu tekstowego profilu.
RegisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Zarejestruj wywołania zwrotne pomocy w podanym ciągu profilu.
RemoveProfileStringContext(ProfileStringContext & inOutContext)
bool
Usuń z rejestru wybrany kontekst obsługi ciągu znaków profilu.
UnregisterProfileStringInfo(ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Wyrejestruj podany ciąg znaków profilu obsługi wywołań zwrotnych.

Struktura
nl::Weave::Support::ProfileStringContext

Kontekst rejestracji i wyrejestrowania wywołań zwrotnych powiązanych z określonym identyfikatorem profilu na potrzeby zwracania zrozumiałych dla człowieka ciągów pomocy powiązanych z profilem.

nl::Weave::Support::ProfileStringInfo

Wywołania zwrotne powiązane z określonym identyfikatorem profilu, które zwracają zrozumiałe dla człowieka ciągi pomocy powiązane z profilem.

Definiuje typ

MessageNameFunct

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

Typedef to funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C z zakończeniem NULL i opisujący typ wiadomości powiązany z określonym identyfikatorem profilu.

To wywołanie zwrotne po zarejestrowaniu jest wywoływane, gdy potrzebny jest zrozumiały dla człowieka ciąg znaków C z zakończeniem NULL do opisania typu wiadomości powiązanego z określonym identyfikatorem profilu.

Szczegóły
Parametry
[in] inProfileId
Identyfikator profilu powiązany z określonym typem wiadomości.
[in] inMsgType
Typ wiadomości, dla której potrzebny jest opisowy ciąg tekstowy zrozumiały dla człowieka.
Zwroty
wskaźnik do ciągu C z zakończeniem NULL, jeśli znajdzie dopasowanie; w przeciwnym razie ma wartość NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef to funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C z zakończeniem NULL i opisujący profil o określonym identyfikatorze.

To wywołanie zwrotne po zarejestrowaniu jest wywoływane, gdy do opisania profilu o określonym identyfikatorze profilu potrzebny jest zrozumiały dla człowieka ciąg znaków C z zakończeniem NULL.

Szczegóły
Parametry
[in] inProfileId
Identyfikator profilu, dla którego potrzebny jest opisowy ciąg tekstowy zrozumiały dla człowieka.
Zwroty
wskaźnik do ciągu C z zakończeniem NULL, jeśli znajdzie dopasowanie; w przeciwnym razie ma wartość NULL.

StatusReportFormatStringFunct

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

Typedef to funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C z zakończeniem NULL i opisujący kod stanu powiązany z określonym identyfikatorem profilu.

To wywołanie zwrotne po zarejestrowaniu jest wywoływane, gdy do opisania kodu stanu powiązanego z określonym identyfikatorem profilu potrzebny jest zrozumiały dla człowieka ciąg C z zakończeniem NULL.

Szczegóły
Parametry
[in] inProfileId
Identyfikator profilu powiązany z określonym kodem stanu.
[in] inStatusCode
Kod stanu, dla którego wymagany jest opis w postaci zrozumiałego dla człowieka.
Zwroty
wskaźnik do ciągu C z zakończeniem NULL, jeśli znajdzie dopasowanie; w przeciwnym razie ma wartość NULL.

Zmienne

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Wskaźnik nagłówka listy połączonej pojedynczo z rejestrem.

Funkcje

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Znajdź ciąg profilu obsługujący kontekst pasujący do określonego kontekstu na podstawie identyfikatora profilu powiązanego z kontekstem.

Ta funkcja znajduje ciąg profilu obsługujący kontekst pasujący do określonego kontekstu na podstawie identyfikatora profilu powiązanego z kontekstem.

Szczegóły
Parametry
[in] inContext
Odwołanie tylko do odczytu do ciągu tekstowego profilu umożliwiającego znalezienie kontekstu.
Zwroty
wskaźnik tylko do odczytu do kontekstu obsługi ciągu znaków profilu (jeśli zostanie znaleziony); w przeciwnym razie ma wartość NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Znajdź, jeśli ciąg profilu jest zarejestrowany, obsługuje wywołania zwrotne powiązane z określonym identyfikatorem profilu.

Szczegóły
Parametry
[in] inProfileId
Identyfikator profilu, dla którego można znaleźć ciąg znaków, który obsługuje wywołania zwrotne.
Zwroty
wskaźnik tylko do odczytu do ciągu znaków profilu, który obsługuje wywołania zwrotne (jeśli zostaną znalezione); w przeciwnym razie ma wartość NULL.
Zobacz też:
RegisterProfielStringInfo
UnregisterProfielStringInfo

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Wstaw do rejestru kontekst obsługi podanego ciągu tekstowego profilu.

Ta funkcja wstawia do rejestru określony kontekst obsługi ciągu znaków profilu, jeśli jeszcze go tam nie ma, w kolejności posortowanej na podstawie identyfikatora profilu rosnącego.

Szczegóły
Parametry
[in,out] inOutContext
Odwołanie do kontekstu obsługi ciągu tekstowego profilu, który zostanie wstawiony do rejestru. Gdy kontekst znajduje się w rejestrze, pole mNext może być modyfikowane w miarę wstawiania lub usuwania innych kontekstów.
Zwroty
true, jeśli wstawiono kontekst; w przeciwnym razie: false.

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Zarejestruj wywołania zwrotne pomocy w podanym ciągu profilu.

Ta funkcja rejestruje i udostępnia podany ciąg znaków profilu obsługi wywołań zwrotnych.

Szczegóły
Parametry
[in,out] inOutContext
Odwołanie do kontekstu obsługi ciągu tekstowego profilu, który zostanie zarejestrowany i dodany do rejestru. Gdy kontekst jest zarejestrowany, pole mNext może być modyfikowane w miarę rejestrowania lub wyrejestrowania innych kontekstów.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Jeśli kontekst jest już zarejestrowany.
Zobacz też:
FindStringProfileInfo
UnregisterProfielStringInfo

RemoveProfileStringContext

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Usuń z rejestru wybrany kontekst obsługi ciągu znaków profilu.

Ta funkcja usuwa z rejestru określony kontekst obsługi ciągu znaków profilu, jeśli istnieje, na podstawie identyfikatora profilu.

Szczegóły
Parametry
[in,out] inOutContext
Odwołanie do kontekstu obsługi ciągu tekstowego profilu, który zostanie usunięty, jeśli występuje. Po usunięciu kontekstu pole mNext może zostać zmienione.
Zwroty
true, jeśli kontekst został usunięty; w przeciwnym razie: false.

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Wyrejestruj podany ciąg znaków profilu obsługi wywołań zwrotnych.

Ta funkcja wyrejestrowuje i sprawia, że podany ciąg znaków profilu obsługuje wywołania zwrotne.

Szczegóły
Parametry
[in,out] inOutContext
Odwołanie do kontekstu obsługi ciągu tekstowego profilu, który zostanie wyrejestrowany, jeśli zostanie zarejestrowany, i usunięty z rejestru. Gdy kontekst nie jest zarejestrowany, pole mNext może zostać zmienione.
Zwracane wartości
WEAVE_NO_ERROR
Powodzenie.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Jeśli kontekst nie jest zarejestrowany.
Zobacz też:
FindStringProfileInfo
RegisterProfielStringInfo