IMDSPDevice::GetName

The GetName method retrieves the name of the device.

Syntax

HRESULT GetName(
  LPWSTR  pwszName,
  UINT  nMaxChars
);

Parameters

pwszName

[out] Pointer to an array of 16-bit Unicode characters that receives the device-name string.

nMaxChars

[in] Maximum number of characters to copy to the string.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code	Description
E_INVALIDARG	A parameter is invalid or is a NULL pointer.
WMDM_E_NOTSUPPORTED	This device does not provide a device name.
WMDM_E_BUFFERTOOSMALL	The buffer specified is too small for the return string. Check nMaxChars for the required buffer size.
E_FAIL	An unspecified error occurred.

Remarks

The LPWSTR string type is a 16-bit Unicode character string and does not accept byte-sized characters. To convert a string of byte-sized characters (LPCSTR) to an LPWSTR string, use the MultiByteToWideChar() function as described in Microsoft® Windows® documentation.

See Also

IMDSPDevice Interface

Previous

Next