Share via

IWMDMDevice::GetName

  • Article
banner art

The GetName method retrieves the name of an installed media device.

Syntax

HRESULT GetName(
  LPWSTR  pwszName,
  UINT  nMaxChars
);

Parameters

pwszName

[out]  Pointer to a (Unicode) wide-character null-terminated string containing the device name.

nMaxChars

[in]  Integer containing the maximum number of characters that can be placed in pwszName.

Return Values

The method returns an HRESULT. All the interface methods in Windows Media Device Manager and service provider can return any of the following classes of error codes:

  • Standard COM error codes
  • Windows error codes converted to HRESULT values
  • Windows Media Device Manager error codes

For a complete list of possible error codes, see Error Codes.

Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.
E_INVALIDARG The pwszName parameter is an invalid or NULL pointer.
WMDM_E_NOTSUPPORTED The device does not have a 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 buffer that pwszName points to must be allocated by the caller, and its size must be sufficient to hold nMaxChars wide characters.

Requirements

Header: Defined in wmdm.idl.

Library: mssachlp.lib

See Also