нл:: Переплетение:: Поддерживать

Краткое содержание

Определения типов

MessageNameFunct )(uint32_t inProfileId, uint8_t inMsgType) определение типа
const char *(*
Typedef для функции обратного вызова, которая возвращает удобочитаемую строку C с завершающим NULL, описывающую тип сообщения, связанный с указанным идентификатором профиля.
ProfileNameFunct )(uint32_t inProfileId) определение типа
const char *(*
Typedef для функции обратного вызова, которая возвращает удобочитаемую строку C с завершающим NULL, описывающую профиль с указанным идентификатором профиля.
StatusReportFormatStringFunct )(uint32_t inProfileId, uint16_t inStatusCode) определение типа
const char *(*
Typedef для функции обратного вызова, которая возвращает удобочитаемую строку C с завершающим NULL, описывающую код состояния, связанный с указанным идентификатором профиля.

Переменные

sProfileStringContextHead
Указатель на заголовок односвязного списка реестра.

Функции

FindProfileStringContext (const ProfileStringContext & inContext)
Найдите контекст поддержки строки профиля, соответствующий указанному контексту, на основе идентификатора профиля, связанного с контекстом.
FindProfileStringInfo (uint32_t inProfileId)
NL_DLL_EXPORT const ProfileStringInfo *
Найдите, если зарегистрирована, строка профиля, поддерживающая обратные вызовы, связанные с указанным идентификатором профиля.
InsertProfileStringContext ( ProfileStringContext & inOutContext)
bool
Вставьте указанный контекст поддержки строки профиля в реестр.
RegisterProfileStringInfo ( ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Зарегистрируйте предоставленные обратные вызовы поддержки строки профиля.
RemoveProfileStringContext ( ProfileStringContext & inOutContext)
bool
Удалите указанный контекст поддержки строки профиля из реестра.
UnregisterProfileStringInfo ( ProfileStringContext & inOutContext)
NL_DLL_EXPORT WEAVE_ERROR
Отмените регистрацию предоставленной строки профиля для поддержки обратных вызовов.

Структуры

nl:: Weave:: Поддержка:: ProfileStringContext

Контекст для регистрации и отмены регистрации обратных вызовов, связанных с указанным идентификатором профиля, для возврата удобочитаемых вспомогательных строк, связанных с профилем.

nl:: Weave:: Поддержка:: ProfileStringInfo

Обратные вызовы, связанные с указанным идентификатором профиля, для возврата удобочитаемых вспомогательных строк, связанных с профилем.

Определения типов

ИмяСообщенияФункция

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

Typedef для функции обратного вызова, которая возвращает удобочитаемую строку C с завершающим NULL, описывающую тип сообщения, связанный с указанным идентификатором профиля.

Этот обратный вызов, если он зарегистрирован, вызывается, когда для описания типа сообщения, связанного с указанным идентификатором профиля, требуется удобочитаемая строка C, завершающаяся NULL.

Подробности
Параметры
[in] inProfileId
Идентификатор профиля, связанный с указанным типом сообщения.
[in] inMsgType
Тип сообщения, для которого ищется удобочитаемая описательная строка.
Возврат
указатель на строку C, завершающуюся NULL, если совпадение найдено; в противном случае НУЛЬ.

ИмяПрофиляФункция

const char *(* ProfileNameFunct)(uint32_t inProfileId)

Typedef для функции обратного вызова, которая возвращает удобочитаемую строку C с завершающим NULL, описывающую профиль с указанным идентификатором профиля.

Этот обратный вызов, если он зарегистрирован, вызывается, когда для описания профиля с указанным идентификатором профиля требуется удобочитаемая строка C, завершающаяся NULL.

Подробности
Параметры
[in] inProfileId
Идентификатор профиля, для которого ищется удобочитаемая описательная строка.
Возврат
указатель на строку C, завершающуюся NULL, если совпадение найдено; в противном случае НУЛЬ.

СтатусРепортФорматСтрокаФункт

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

Typedef для функции обратного вызова, которая возвращает удобочитаемую строку C с завершающим NULL, описывающую код состояния, связанный с указанным идентификатором профиля.

Этот обратный вызов, если он зарегистрирован, вызывается, когда для описания кода состояния, связанного с указанным идентификатором профиля, требуется удобочитаемая строка C, завершающаяся NULL.

Подробности
Параметры
[in] inProfileId
Идентификатор профиля, связанный с указанным кодом состояния.
[in] inStatusCode
Код состояния, для которого ищется удобочитаемая описательная строка.
Возврат
указатель на строку C, завершающуюся NULL, если совпадение найдено; в противном случае НУЛЬ.

Переменные

спрофилестрингконтекстхед

ProfileStringContext * sProfileStringContextHead

Указатель на заголовок односвязного списка реестра.

Функции

Найтипрофилестрингконтекст

ProfileStringContext * FindProfileStringContext(
  const ProfileStringContext & inContext
)

Найдите контекст поддержки строки профиля, соответствующий указанному контексту, на основе идентификатора профиля, связанного с контекстом.

Эта функция находит контекст поддержки строки профиля, соответствующий указанному контексту, на основе идентификатора профиля, связанного с контекстом.

Подробности
Параметры
[in] inContext
Доступная только для чтения ссылка на контекст поддержки строки профиля, который нужно найти.
Возврат
указатель только для чтения на контекст поддержки строки профиля, если он найден; в противном случае НУЛЬ.

Найтипрофилестрингинформо

NL_DLL_EXPORT const ProfileStringInfo * FindProfileStringInfo(
  uint32_t inProfileId
)

Найдите, если зарегистрирована, строка профиля, поддерживающая обратные вызовы, связанные с указанным идентификатором профиля.

Подробности
Параметры
[in] inProfileId
Идентификатор профиля, для которого нужно найти обратные вызовы поддержки строк.
Возврат
указатель только для чтения на строку профиля, поддерживающую обратные вызовы, если найден; в противном случае НУЛЬ.
См. также:
РегистрацияПрофильСтрокаИнфо
Отменить регистрациюProfielStringInfo

Инсертспрофилестрингконтекст

bool InsertProfileStringContext(
  ProfileStringContext & inOutContext
)

Вставьте указанный контекст поддержки строки профиля в реестр.

Эта функция вставляет указанный контекст поддержки строки профиля в реестр, если он еще не существует, в отсортированном порядке на основе возрастающего идентификатора профиля.

Подробности
Параметры
[in,out] inOutContext
Ссылка на контекст поддержки строки профиля, который будет вставлен в реестр. Пока контекст присутствует в реестре, поле mNext может быть изменено по мере вставки или удаления других контекстов.
Возврат
true, если контекст был вставлен; в противном случае ложь.

РегистрацияПрофилеСтрокаИнформация

NL_DLL_EXPORT WEAVE_ERROR RegisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Зарегистрируйте предоставленные обратные вызовы поддержки строки профиля.

Эта функция регистрирует и делает доступными предоставленные обратные вызовы поддержки строки профиля.

Подробности
Параметры
[in,out] inOutContext
Ссылка на контекст поддержки строки профиля, который будет зарегистрирован и добавлен в реестр. Пока контекст зарегистрирован, поле mNext может быть изменено по мере регистрации или отмены регистрации других контекстов.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_ALREADY_REGISTERED
Если контекст уже зарегистрирован.
См. также:
Найтистрокупрофилеинформо
Отменить регистрациюProfielStringInfo

Ремофилестрингконтекст

bool RemoveProfileStringContext(
  ProfileStringContext & inOutContext
)

Удалите указанный контекст поддержки строки профиля из реестра.

Эта функция удаляет указанный контекст поддержки строки профиля из реестра, если он присутствует, на основе идентификатора профиля.

Подробности
Параметры
[in,out] inOutContext
Ссылка на контекст поддержки строки профиля, который будет удален, если он присутствует. Когда контекст удален, поле mNext может быть изменено.
Возврат
true, если контекст был удален; в противном случае ложь.

Отменить регистрацию профиляStringInfo

NL_DLL_EXPORT WEAVE_ERROR UnregisterProfileStringInfo(
  ProfileStringContext & inOutContext
)

Отмените регистрацию предоставленной строки профиля для поддержки обратных вызовов.

Эта функция отменяет регистрацию и делает недоступными предоставленные обратные вызовы поддержки строки профиля.

Подробности
Параметры
[in,out] inOutContext
Ссылка на контекст поддержки строки профиля, который будет отменен, если зарегистрирован, и удален из реестра. Если контекст не зарегистрирован, поле mNext может быть изменено.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
WEAVE_ERROR_PROFILE_STRING_CONTEXT_NOT_REGISTERED
Если контекст не зарегистрирован.
См. также:
Найтистрокупрофилеинформо
РегистрацияПрофильСтрокаИнфо