Share via

IWMDMStorage::GetName

  • Article
banner art

The GetName method retrieves the display name of a storage object.

Syntax

HRESULT GetName(
  LPWSTR  pwszName,
  UINT  nMaxChars
);

Parameters

pwszName

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

nMaxChars

[in]  Integer containing the maximum number of characters that can be copied to the name string.

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.
E_FAIL An unspecified error occurred.

Remarks

The display name of the object is the file name without path information. In hierarchical media, the display name is concatenated with the ancestor instances of IWMDMStorage interfaces to create a full path-qualified name.

The LPWSTR string type is a 16-bit Unicode character string and does not accept byte-sized characters.

Requirements

Header: Defined in wmdm.idl.

Library: mssachlp.lib

See Also