Provided by: tcl-trf-doc_2.1.4-dfsg3-2build1_all bug

NAME

       Trf_CheckOptions - Interface to procedures to check an option container.

SYNOPSIS

       #include <transform.h>

       int Trf_CheckOptions
       (
            Trf_Options options,
            Tcl_Interp *interp,
            const Trf_BaseOptions *baseOptions,
            ClientData clientData
       );

PARAMETERS

       Trf_Options options
              Container with options to check.

       Tcl_Interp *interp
              Interpreter to write error messages to (NULL possible!).

       const Trf_BaseOptions *baseOptions
              Info about common options.

       ClientData clientData
              Arbitrary information, as defined in Trf_TypeDefinition.clientData.

DESCRIPTION

       The  procedure  has  to check the contents of the specified container for errors, consistency, etc. It is
       allowed to set default values into unspecified slots. Return value is a standard tcl error code. In  case
       of  failure  and  interp  not  NULL  an  error message should be left in the result area of the specified
       interpreter.

SEE ALSO

       Trf_Init(3),   Trf_SafeInit(3),   Trf_IsInitialized(3),    Trf_CreateOptions(3),    Trf_DeleteOptions(3),
       Trf_SetOption(3),  Trf_SetObjOption(3),  Trf_QueryOptions(3),  Trf_SeekQueryOptions(3), Trf_WriteProc(3),
       Trf_CreateCtrlBlock(3),   Trf_DeleteCtrlBlock(3),   Trf_TransformCharacter(3),    Trf_TransformBuffer(3),
       Trf_FlushTransformation(3),       Trf_ClearCtrlBlock(3),       Trf_QueryMaxRead(3),      Trf_Register(3),
       Trf_ConverterOptions(3),    Trf_MDStart(3),    Trf_MDUpdate(3),    Trf_MDUpdateBuf(3),    Trf_MDFinal(3),
       Trf_MDCheck(3), Trf_RegisterMessageDigest(3), Trf_LoadLibrary(3), Trf_XorBuffer(3), Trf_ShiftRegister(3),
       Trf_FlipRegisterShort(3), Trf_FlipRegisterLong(3), Trf_InitStubs(3)