Sample file: documenting a testpoint handler.

This file is located in VideoClick2.1/interface/h/TestPoints/handlers.

/************************************************************
* This is a part of the VideoClick project.
* Copyright (C) 1998 Vsoft Ltd.
* All rights reserved.
* NAME: DataSinkHandlerParam.h
*
* Description: parameters used by the DataSinkHandler
*
*
* $Archive: /VideoClick2.1/Interface/h/TestPoints/handlers/DataSinkHandlerParam.h $
* $Revision: 2 $
* $Author: Noam $
* $JustDate: 22/08/99 $
************************************************************/
/*
Name (friendly name):
-------------------
    Test point Handler for IDataSink2

ProgId
-------------------
    Vsoft.DataSinkHandler

Author
-------------------
    Noam Cohen , 22 Aug 1999

Description:
-------------------
    This handler writes data into a dump file.
    All data written into IDataSink2 or IDataSinkWithReset is written to the current dump file.
    The dump file name and behaviour is configured in the registry ( see below ).

Interfaces exposed:
-------------------
    IDataSink2
    IDataSinkWithReset

When to use:
-------------------
    You can use this handler directly do dump any buffer into IDataSink2.
    If you have IDataSink or IDataSource filters and you want to see what's moving
    between them, connect a SinkTestPoint or SourcrTestPoint class between them.
    These helper classes connect to this handler.

Parameters:
-------------------
    The parameters are stored in the registry, under the key of each testpoint.
    - "File" [string] - file name used a the basis for the current dump file name.
        The actual file name is F_T_P_N.EXT where:
        F - string supplied in "File"
        P - process id
        T = thread id
        N - running number starting with 001
        EXT - string supplied in "File"

    - "UseNewFileAfterReset"=dword:00000000 - if non zero, when
        IDataSinkWithReset::Reset() is called, the current file is closed and a new file
        is opened. This parameter is optional.

    NOTE: the decision of which interface to use is simply when asking an interface.
            It is not stored in the registry.


Sample Registry key :
-------------------
The following values define the handler for a certain TP, and the handler's parametrs.

[HKEY_LOCAL_MACHINE\SOFTWARE\Vsoft\TestPoints\{BCB9DFB3-406F-11d3-AEF9-000000000000}]
"ProgID"="Vsoft.DataSinkHandler"
"File"="d:\\tmp\\tp1.mpg"
"CLSID"="{BCB9DFB2-406F-11d3-AEF9-000000000000}"
"UseNewFileAfterReset"=dword:00000001

Last update:
-------------------
    22 Aug 1999
*/

// {BCB9DFB2-406F-11d3-AEF9-000000000000}
static const GUID CLSID_DataSinkTpHandler =
{ 0xbcb9dfb2, 0x406f, 0x11d3, { 0xae, 0xf9, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } };