MFCreateSensorGroup function (mfidl.h)

Article
10/13/2021

Creates an instance of the IMFSensorGroup interface based on the provided symbolic link name.

Syntax

HRESULT MFCreateSensorGroup(
        LPCWSTR        SensorGroupSymbolicLink,
  [out] IMFSensorGroup **ppSensorGroup
);

Parameters

SensorGroupSymbolicLink

The symbolic link for the new IMFSensorGroup. This name can be obtained through device enumeration APIs such as SetupDiGetClassDevs or MFEnumDeviceSources or by getting the Id property of the DeviceInformation class.

[out] ppSensorGroup

The symbolic link for the new IMFSensorGroup.

Return value

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The supplied IMFSensorGroup is null.
E_INVALIDARG	The supplied LPCWSTR is null.

Remarks

If the function succeeds, ppSensorGroup will point to a valid IMFSensorGroup object. The caller must release this interface.

Note When this API is used with a KSCATEGORY_SENSOR_CAMERA or KSCATEGORY_VIDEO_CAMERA symbolic name, the resulting IMFSensorGroup object will only contain one sensor device but behaves as a virtualized sensor group. The caller may use the resulting object in the same manner as a sensor group obtained from a KSCATEGORY_SENSOR_GROUP.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1607 [desktop apps \| UWP apps]
Minimum supported server	None supported
Target Platform	Windows
Header	mfidl.h

Share via