ITocEntry::GetTitle method (wmcodecdsp.h)

The GetTitle method retrieves the title, set by a previous call to SetTitle, of the entry.

Syntax

HRESULT GetTitle(
  [in, out] WORD   *pwTitleSize,
  [out]     LPWSTR pwszTitle
);

Parameters

[in, out] pwTitleSize

If pwszTitle is NULL, this is an output parameter that receives the size, in wide characters, of the buffer required to receive the title. If pwszTitle is not NULL, this is an input parameter that specifies the size, in wide characters, of the caller-allocated buffer pointed to by pwszTitle.

[out] pwszTitle

NULL, or a pointer to a caller-allocated buffer that, on successful completion, receives the title. The title is null-terminated.

Return value

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

Return code	Description
S_OK	The method succeeded.
MF_E_BUFFERTOOSMALL	The method returns this error code if pwszTitle is not NULL and the title, including its NULL terminator, is larger than the size specified by pwTitleSize. In that case, pwTitleSize serves as an output parameter and receives the size of the required buffer.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	wmcodecdsp.h
DLL	Wmvdspa.dll

See also

ITocEntry

SetTitle