trf_checkoptions(3) [debian man page]

Trf_CheckOptions(3)					     Library Functions Manual					       Trf_CheckOptions(3)

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)

c2man transform.h						  27 August 2002					       Trf_CheckOptions(3)

Trf_TransformBuffer(3)					     Library Functions Manual					    Trf_TransformBuffer(3)

NAME

       Trf_TransformBuffer - Interface to procedures for transformation of character sequences.

SYNOPSIS

       #include <transform.h>

       int Trf_TransformBuffer
       (
	    Trf_ControlBlock ctrlBlock,
	    unsigned char *buf,
	    int bufLen,
	    Tcl_Interp *interp,
	    ClientData clientData
       );

PARAMETERS

       Trf_ControlBlock ctrlBlock
	      State of encoder/decoder.

       unsigned char *buf
	      Characters to transform.

       int bufLen
	      Number of characters.

       Tcl_Interp *interp
	      Interpreter for error messages (NULL possible).

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

DESCRIPTION

       A  procedure  of  this type is called to encode/decode a complete buffer. 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. Only one of  'Trf_TransformCharacter'  and
       'Trf_TransformBuffer'  must  be	provided.  The	first  named  is  easier to implement, this one should be faster. If both are provided, ->
       'Trf_TransformBuffer' takes precedence.

SEE ALSO

       Trf_Init(3), Trf_SafeInit(3),  Trf_IsInitialized(3),  Trf_CreateOptions(3),  Trf_DeleteOptions(3),  Trf_CheckOptions(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_FlushTransformation(3),	Trf_ClearCtrlBlock(3),	Trf_QueryMaxRead(3),   Trf_Register(3),   Trf_ConverterOp-
       tions(3),  Trf_MDStart(3),  Trf_MDUpdate(3),  Trf_MDUpdateBuf(3), Trf_MDFinal(3), Trf_MDCheck(3), Trf_RegisterMessageDigest(3), Trf_LoadLi-
       brary(3), Trf_XorBuffer(3), Trf_ShiftRegister(3), Trf_FlipRegisterShort(3), Trf_FlipRegisterLong(3), Trf_InitStubs(3)

c2man transform.h						  27 August 2002					    Trf_TransformBuffer(3)