IToc::GetContext method (wmcodecdsp.h)

The GetContext method retrieves a block of bytes that was previously associated with the table of contents by a call to SetContext.

Syntax

HRESULT GetContext(
  [in, out] DWORD *pdwContextSize,
  [out]     BYTE  *pbtContext
);

Parameters

[in, out] pdwContextSize

If pbtContext is NULL, this is an output parameter that receives the size, in bytes, of the context block. If pbtContext is not NULL, this is an input parameter that specifies the size, in bytes, of the caller-allocated buffer pointed to by pbtContext.

[out] pbtContext

NULL, or a pointer to a caller-allocated buffer that, on successful completion, receives the context block.

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 pbtContext is not NULL and the context block is larger than the size specified by bdwContextSize. In that case, pdwContextSize serves as an output parameter and receives the size, in bytes, of the required buffer.

Requirements

   
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

IToc