Edit

Share via

IMFSensorDevice::GetSymbolicLink method (mfidl.h)

  • Article

Gets the symbolic link name of the sensor device.

Syntax

HRESULT GetSymbolicLink(
  [out] LPWSTR SymbolicLink,
  [in]  LONG   cchSymbolicLink,
  [out] LONG   *pcchWritten
);

Parameters

[out] SymbolicLink

Buffer of cchSymbolicLink characters where the symbolic link name will be written. The buffer must be large enough to account for the null terminator.

[in] cchSymbolicLink

Number of characters available in SymbolicLink buffer.

[out] pcchWritten

Output parameter containing the number of characters written to SymbolicLink. This includes the null terminator. If SymbolicLink is null and cchSymbolicLink is 0, pcchWritten will contain the number of characters needed (including the null terminator) to store the symbolic link name.

Return value

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

Return code Description
S_OK
 The method succeeded.
ERROR_INSUFFICIENT_BUFFER
 The buffer provided in the SymbolicLink parameter is not large enough to contain the symbolic link name, including the null terminator.
MF_E_NOT_INITIALIZED
 The sensor device has not been initialized.

Remarks

Depending on the type of device, which is defined by a member of the MFSensorDeviceType enumeration and can be obtained by calling GetDeviceType, the resulting symbolic name may be a valid device symbolic name or a provider URL. The caller should not attempt to parse the name and should treat it as opaque data.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1607 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header mfidl.h
Library Mfplat.lib; Mfplat.dll

See also

IMFSensorDevice