IMDSPStorage::GetName

The GetName method retrieves the display name of the 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

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

Return code	Description
E_INVALIDARG	The pwszName parameter is an invalid or NULL pointer.
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 display name of the object is the filename 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.

See Also

IMDSPStorage Interface

Previous

Next