nl::Weave::Support

Podsumowanie

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

Zmienne
sProfileStringContextHead
Wskaźnik nagłówka listy z pojedynczym linkiem.

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

Konstrukcja
nl::Weave::Support::ProfileStringContext

Kontekst rejestrowania i wyrejestrowywania 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 służącym do zwracania zrozumiałych dla człowieka ciągów pomocy powiązanych z profilem.

Definicje typów

MessageNameFunct

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

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

To wywołanie zwrotne jest wywoływane, gdy potrzebny jest zrozumiały dla człowieka ciąg C z zakończeniem NULL w celu 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órego poszukiwany jest zrozumiały dla człowieka ciąg opisowy.
Zwroty
wskaźnik do ciągu znaków C zakończonego wartością NULL w przypadku znalezienia dopasowania. W przeciwnym razie ma wartość NULL.

ProfileNameFunct

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef dla funkcji wywołania zwrotnego, która zwraca zrozumiały dla człowieka ciąg C zakończony wartością NULL, opisujący profil z określonym identyfikatorem profilu.

To wywołanie zwrotne jest wywoływane, gdy do opisania profilu 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, w którym poszukiwany jest zrozumiały dla człowieka ciąg opisowy.
Zwroty
wskaźnik do ciągu znaków C zakończonego wartością NULL w przypadku znalezienia dopasowania. W przeciwnym razie ma wartość NULL.

StatusReportFormatStringFunct

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

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

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

Szczegóły
Parametry
[in] inProfileId
Identyfikator profilu powiązany z określonym kodem stanu.
[in] inStatusCode
Kod stanu, w którego przypadku szuka się ciągu opisowego w postaci zrozumiałej dla człowieka.
Zwroty
wskaźnik do ciągu znaków C zakończonego wartością NULL w przypadku znalezienia dopasowania. W przeciwnym razie ma wartość NULL.

Zmienne

sProfileStringContextHead

ProfileStringContext * sProfileStringContextHead

Wskaźnik nagłówka listy z pojedynczym linkiem.

Funkcje

FindProfileStringContext

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Znajdź kontekst obsługi ciągu profilu pasującego do określonego kontekstu na podstawie identyfikatora profilu powiązanego z kontekstem.

Ta funkcja znajduje kontekst obsługi ciągu profilu pasującego do określonego kontekstu na podstawie identyfikatora profilu powiązanego z kontekstem.

Szczegóły
Parametry
[in] inContext
Odwołanie tylko do odczytu do kontekstu obsługi ciągu profilu do znalezienia.
Zwroty
wskaźnik tylko do odczytu do kontekstu obsługi ciągu profilu, jeśli został znaleziony; w przeciwnym razie ma wartość NULL.

FindProfileStringInfo

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

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

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

InsertProfileStringContext

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Wstaw określony kontekst obsługi ciągu znaków profilu do rejestru.

Ta funkcja wstawia do rejestru określony kontekst obsługi ciągu profilu (jeśli nie jest jeszcze dostępny) w posortowanej kolejności na podstawie identyfikatora profilu rosnącego.

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

RegisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Zarejestruj wywołania zwrotne dotyczące podanego ciągu profilu.

Ta funkcja rejestruje i udostępnia wywołania zwrotne obsługujące podany ciąg profilu.

Szczegóły
Parametry
[in,out] inOutContext
Odwołanie do kontekstu obsługi ciągu 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
Na sukces.
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 określony kontekst obsługi ciągu znaków profilu.

Ta funkcja usuwa z rejestru określony kontekst obsługi ciągu profilu (jeśli istnieje) na podstawie identyfikatora profilu.

Szczegóły
Parametry
[in,out] inOutContext
Odwołanie do kontekstu obsługi ciągu profilu, który zostanie usunięty (jeśli występuje). Po usunięciu kontekstu można zmienić pole mNext.
Zwroty
Wartość true, jeśli kontekst został usunięty, w przeciwnym razie – false (fałsz).

UnregisterProfileStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Wyrejestruj wywołania zwrotne dotyczące podanego ciągu profilu.

Ta funkcja wyrejestrowuje i uniemożliwia podane wywołania zwrotne ciągu profilu obsługującego wywołania zwrotne.

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