Skip to content

Latest commit

 

History

History
134 lines (109 loc) · 4.16 KB

nf-mmdeviceapi-immdevice-openpropertystore.md

File metadata and controls

134 lines (109 loc) · 4.16 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mmdeviceapi.IMMDevice.OpenPropertyStore
IMMDevice::OpenPropertyStore (mmdeviceapi.h)
The OpenPropertyStore method retrieves an interface to the device's property store.
IMMDevice interface [Core Audio]
OpenPropertyStore method
IMMDevice.OpenPropertyStore
IMMDevice::OpenPropertyStore
IMMDeviceOpenPropertyStore
OpenPropertyStore
OpenPropertyStore method [Core Audio]
OpenPropertyStore method [Core Audio]
IMMDevice interface
coreaudio.immdevice_openpropertystore
mmdeviceapi/IMMDevice::OpenPropertyStore
coreaudio\immdevice_openpropertystore.htm
CoreAudio
d13a5743-8b07-4876-ab9d-7a6bd60e7add
12/05/2018
IMMDevice interface [Core Audio],OpenPropertyStore method, IMMDevice.OpenPropertyStore, IMMDevice::OpenPropertyStore, IMMDeviceOpenPropertyStore, OpenPropertyStore, OpenPropertyStore method [Core Audio], OpenPropertyStore method [Core Audio],IMMDevice interface, coreaudio.immdevice_openpropertystore, mmdeviceapi/IMMDevice::OpenPropertyStore
mmdeviceapi.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Windows
19H1
IMMDevice::OpenPropertyStore
mmdeviceapi/IMMDevice::OpenPropertyStore
c++
APIRef
kbSyntax
COM
Mmdeviceapi.h
IMMDevice.OpenPropertyStore

IMMDevice::OpenPropertyStore

-description

The OpenPropertyStore method retrieves an interface to the device's property store.

-parameters

-param stgmAccess [in]

The storage-access mode. This parameter specifies whether to open the property store in read mode, write mode, or read/write mode. Set this parameter to one of the following STGM constants:

STGM_READ

STGM_WRITE

STGM_READWRITE

The method permits a client running as an administrator to open a store for read-only, write-only, or read/write access. A client that is not running as an administrator is restricted to read-only access. For more information about STGM constants, see the Windows SDK documentation.

-param ppProperties [out]

Pointer to a pointer variable into which the method writes the address of the IPropertyStore interface of the device's property store. Through this method, the caller obtains a counted reference to the interface. The caller is responsible for releasing the interface, when it is no longer needed, by calling the interface's Release method. If the OpenPropertyStore call fails, *ppProperties is NULL. For more information about IPropertyStore, see the Windows SDK documentation.

-returns

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code Description
E_INVALIDARG
Parameter stgmAccess is not a valid access mode.
E_POINTER
Parameter ppProperties is NULL.
E_OUTOFMEMORY
Out of memory.

-remarks

In general, the properties in the device's property store are read-only for clients that do not perform administrative, system, or service functions.

For code examples that call the OpenPropertyStore method, see the following topics:

-see-also

IMMDevice Interface