ISensor::GetFriendlyName method (sensorsapi.h)
Retrieves the sensor name that is intended to be seen by the user.
Syntax
HRESULT GetFriendlyName(
[out] BSTR *pFriendlyName
);
Parameters
[out] pFriendlyName
Address of a BSTR that receives the friendly name.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
The sensor driver did not provide a friendly name value. The value provided through pFriendlyName is not valid. |
|
NULL was passed in for pFriendlyName. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps only] |
| Minimum supported server | None supported |
| Target Platform | Windows |
| Header | sensorsapi.h |
| Library | Sensorsapi.lib |
| DLL | Sensorsapi.dll |