IWMMutualExclusion2::SetRecordName method (wmsdkidl.h)

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The SetRecordName method assigns a name to a record. You should assign a name to every record so that you can easily identify the records in the future.

Syntax

HRESULT SetRecordName(
  [in] WORD                    wRecordNumber,
  [in] LPCWSTR_WMSDK_TYPE_SAFE pwszRecordName
);

Parameters

[in] wRecordNumber

WORD containing the record number to which you want to assign a name.

[in] pwszRecordName

Pointer to a wide-character null-terminated string containing the name you want to assign to the record. Record names are limited to 256 wide characters.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Remarks

If you pass an empty string as pwszRecordName, the method returns S_OK, but nothing is done.

Requirements

See also

IWMMutualExclusion2 Interface

IWMMutualExclusion2::GetRecordName