IToc::SetContext Method

  • Article

The SetContext method associates a caller-supplied context block with the table of contents.

Syntax

HRESULT SetContext(
  [in]  DWORD dwContextSize,
  [in]  BYTE *pbtContext
);

Parameters

  • dwContextSize [in]
    The size, in bytes, of the context block.

  • pbtContext [in]
    Pointer to the first byte of 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.

 

Remarks

You can use this method to associate any information with the table of contents. The type of information you store in the context block is completely up to you. TOC Parser does not inspect or interpret the context block.

Requirements

Minimum supported client

 Windows Vista

Minimum supported server

 Windows Server 2008

Header

 Wmcodecdsp.h

DLL

 Wmvdspa.dll

See Also

IToc

GetContext

 

 

Send comments about this topic to Microsoft

Build date: 4/7/2010