IWMDMOperation::SetObjectName (deprecated)
.gif) |
This is preliminary documentation and subject to change.
This topic documents a feature of the Windows Media Device Manager SDK. We recommend that you migrate your application to use the Windows Portable Devices API. For more information, see the Windows Portable Devices SDK.
The SetObjectName method assigns a name to the content being read or written. This method is currently not called by Windows Media Device Manager.
Syntax
HRESULT SetObjectName(
LPWSTR pwszName,
UINT nMaxChars
);
Parameters
pwszName
[in] Pointer to a wide-character null-terminated string specifying the object name.
nMaxChars
[in] Integer specifying the maximum number of characters that this string can hold.
Return Values
The application should return one of the following HRESULT values.
| Return code | Description |
| S_OK | The read operation should continue. |
| WMDM_E_USER_CANCELLED | The read operation should be cancelled without finishing. |
| E_FAIL | An unspecified error occurred, and the read operation should be cancelled without finishing. |
If either E_FAIL or WMDM_E_USER_CANCELLED is returned from this call, the operation is cancelled and the End method is called. If the application is using block mode and returns WMDM_E_USER_CANCELLED, then Windows Media Device Manager will return that error to the application.
Remarks
This method is called after BeginRead is called.
Requirements
Header: Defined in mswmdm.h.
Library: mssachlp.lib
See Also