Функция AcxObjectBagRetrieveString (acxmisc.h)
Функция AcxObjectBagRetrieveString извлекает объект WDFSTRING из существующего инициализированного AcxObjectBag.
Синтаксис
NTSTATUS AcxObjectBagRetrieveString(
ACXOBJECTBAG ObjectBag,
PCUNICODE_STRING ValueName,
WDFSTRING Value
);
Параметры
ObjectBag
Инициализированный объект ObjectBag ACX. Дополнительные сведения см. в разделе ACX — сводка по объектам ACX.
ValueName
ЗначениеName, которое будет связано с добавленной строкой и будет использоваться для получения хранимой строки.
Value
Значение объекта WDFSTRING, извлекаемое из ObjectBag.
Возвращаемое значение
Возвращает STATUS_SUCCESS
, если вызов выполнен успешно. В противном случае возвращается соответствующий код ошибки. Дополнительные сведения см. в использовании значений NTSTATUS.
Замечания
Пример
В этом примере показано использование AcxObjectBagRetrieveString.
status = RtlUnicodeStringInit(&usName, inParams->ValueName);
if (!NT_SUCCESS(status))
{
DrvLogError(g_RecorderLog, FLAG_DDI,
"WDFDEVICE %p, RtlUnicodeStringInit(%S) failed, %!STATUS!",
m_Device, inParams->ValueName, status);
goto exit;
}
//
// Set the specified property.
//
switch(inParams->ValueType)
{
case REG_SZ:
//
// Create an empty WDF string to get the value.
//
status = WdfStringCreate(nullptr, nullptr, &wsValue);
if (!NT_SUCCESS(status))
{
DrvLogError(g_RecorderLog, FLAG_DDI,
"WDFDEVICE %p, WdfStringCreate failed, %!STATUS!",
m_Device, status);
goto exit;
}
//
// Get the string value from bag.
//
status = AcxObjectBagRetrieveString(objBag, &usName, wsValue);
Требования к ACX
минимальная версия ACX: 1.0
Дополнительные сведения о версиях ACX см. в обзоре версий ACX.
Требования
Требование | Ценность |
---|---|
заголовка | acxmisc.h |
IRQL | PASSIVE_LEVEL |