IMDSPStorage::GetName

  • Article
banner art

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

Syntax

HRESULT GetName(LPWSTRpwszName,UINTnMaxChars);

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 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 an extenstive 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.
WMDM_E_BUFFERTOOSMALL The buffer specified is too small for the return string. Check nMaxChars for the required buffer size.
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 would be concatenated with the ancestor instances of IMDSPStorage 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.

This method must be implemented. It must not return WMDM_E_NOTSUPPORTED or E_NOTIMPL. For more information, see Mandatory and Optional Interfaces.

Requirements

Header: Defined in mswmdm.h.

Library: mssachlp.lib

See Also