Share via

IWMDMOperation::SetObjectName

  • Article
banner art

The SetObjectName method assigns a name to the content being read or written.

Syntax

HRESULT SetObjectName(
  LPWSTR  pwszName,
  UINT  nMaxChars
);

Parameters

pwszName

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

nMaxChars

[in]  Integer containing the maximum number of characters that this string can hold.

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.
WMDM_E_USER_CANCELLED The application instructs Windows Media Device Manager to cancel the current operation without waiting for it to finish.
E_FAIL An unspecified error occurred.

Remarks

This method is called after BeginRead is called. 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 this same error to the application.

Requirements

Header: Defined in wmdm.idl.

Library: mssachlp.lib

See Also