IoWMISetSingleInstance
TOC
Collapse the table of content
Expand the table of content

IoWMISetSingleInstance routine

The IoWMISetSingleInstance routine sets the values for properties within the data block instance that matches the specified WMI class and instance name.

Syntax


NTSTATUS IoWMISetSingleInstance(
  _In_ PVOID           DataBlockObject,
  _In_ PUNICODE_STRING InstanceName,
  _In_ ULONG           Version,
  _In_ ULONG           ValueBufferSize,
  _In_ PVOID           ValueBuffer
);

Parameters

DataBlockObject [in]

Pointer to a WMI data block object. The caller opens the data block object for the WMI class with the IoWMIOpenBlock routine. The object must be opened with the WMIGUID_SET access right.

InstanceName [in]

Specifies the name of the instance of the data block. This value corresponds to the value of the InstanceName property for the block.

Version [in]

Reserved for future use. Callers must set this parameter to zero.

ValueBufferSize [in]

Specifies the size, in bytes, of the buffer passed in the ValueBuffer parameter.

ValueBuffer [in]

Pointer to the buffer that contains the new values for the properties within the data block.

Return value

The routine returns an NTSTATUS code. Possible return values include:

Return codeDescription
STATUS_SUCCESS

The operation succeeded. The values of the WMI data block instance properties are updated to the contents of the buffer pointed to by the ValueBuffer parameter.

STATUS_WMI_GUID_NOT_FOUND

No drivers implement the WMI class.

STATUS_WMI_INSTANCE_NOT_FOUND

No driver implements an instance of the WMI class with InstanceName property equal to the value specified in the InstanceName parameter.

STATUS_WMI_READ_ONLY

All properties of the WMI class are read-only.

STATUS_WMI_SET_FAILURE

The driver that implements the WMI data block instance is unable to update the instance.

 

Remarks

IoWMISetSingleInstance determines which drivers might support the specified WMI class and instance name, and issues an IRP_MN_CHANGE_SINGLE_INSTANCE request to each such driver. The driver that exports the data block instance with matching InstanceName property updates its data block instance. Note that a data block might have both read-only and read/write properties. In this case, only the read/write properties will be updated and STATUS_SUCCESS is returned.

Drivers can also use the IoWMISetSingleItem routine to update a single property within the class instance.

Requirements

Target platform

Universal

Version

Available in Windows XP and later versions of the Windows operating system.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

<= APC_LEVEL

See also

IoWMIOpenBlock
IoWMIQuerySingleInstance
IoWMISetSingleItem
IRP_MN_CHANGE_SINGLE_INSTANCE

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft