IMDSPDevice2::GetStorage

  • Article
banner art

The GetStorage method makes it possible to go directly to a storage based on its name instead of enumerating through all storages to find it.

Syntax

HRESULT GetStorage(LPCWSTRpszStorageName,IMDSPStorage**ppStorage);

Parameters

pszStorageName

[in]  Pointer to a null-terminated string containing the name of the storage to find.

ppStorage

[out]  Pointer to the storage object specified by the pszStorageName parameter.

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.
S_FALSE The storage cannot be found.
E_FAIL An unspecified error occurred.
E_NOTIMPL The method is not implemented.

Remarks

The GetStorage method does not support wildcard characters. It is not recursive, that is, it will only find storages in the root of the device.

If this method is not implemented, it should return E_NOTIMPL. (It should not return WMDM_E_NOT_SUPPORTED or any other codes indicating that this method is not implemented). This will ensure that Windows Media Device Manager will attempt to substitute this functionality itself by enumerating all storages to find a match based on the storage name passed in as pszStorageName.

It is strongly recommended that a service provider implement this method to efficiently return a storage object based on name.

This method is optional. For more information, see Mandatory and Optional Interfaces.

Requirements

Header: Defined in mswmdm.h.

Library: mssachlp.lib

See Also