AcxObjectBagRetrieveString, fonction (acxmisc.h)
La fonction AcxObjectBagRetrieveString récupère un objet WDFSTRING à partir d’un AcxObjectBag initialisé existant.
Syntaxe
NTSTATUS AcxObjectBagRetrieveString(
ACXOBJECTBAG ObjectBag,
PCUNICODE_STRING ValueName,
WDFSTRING Value
);
Paramètres
ObjectBag
Objet ACX ObjectBag initialisé. Pour plus d’informations, consultez ACX - Résumé des objets ACX.
ValueName
ValeurName qui sera associée à la chaîne ajoutée et qui sera utilisée pour récupérer la chaîne stockée.
Value
Valeur de l’objet WDFSTRING à récupérer à partir de ObjectBag.
Valeur retournée
Retourne STATUS_SUCCESS
si l’appel a réussi. Sinon, elle retourne un code d’erreur approprié. Pour plus d’informations, consultez Utilisation de valeurs NTSTATUS.
Remarques
Exemple
Cet exemple montre l’utilisation d’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);
Configuration requise pour ACX
Version ACX minimale : 1.0
Pour plus d’informations sur les versions d’ACX, consultez Vue d’ensemble des versions d’ACX.
Configuration requise
Condition requise | Valeur |
---|---|
En-tête | acxmisc.h |
IRQL | PASSIVE_LEVEL |