IMFSensorActivityReport::GetFriendlyName method (mfidl.h)

  • Article

Gets the friendly name for the sensor associated with the report.

Syntax

HRESULT GetFriendlyName(
  [out]     LPWSTR FriendlyName,
  [in]      ULONG  cchFriendlyName,
  [in, out] ULONG  *pcchWritten
);

Parameters

[out] FriendlyName

The string into which the sensor friendly name is written.

[in] cchFriendlyName

The character count of the FriendlyName string.

[in, out] pcchWritten

Receives the number of characters that were written into the FriendlyName string.

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.
E_POINTER
 The pcchWritten parameter is null.

Requirements

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

See also

IMFSensorActivityReport