File: Trf_SetObjOption.3

package info (click to toggle)
tcltrf 2.1.4-dfsg3-8
  • links: PTS
  • area: main
  • in suites: sid, trixie
  • size: 9,656 kB
  • sloc: ansic: 73,139; sh: 3,155; tcl: 1,343; makefile: 182; exp: 22
file content (84 lines) | stat: -rw-r--r-- 1,986 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
.TH "Trf_SetObjOption" 3 "27 August 2002" "c2man transform.h"
.SH "NAME"
Trf_SetObjOption \- Interface to procedures to define the value of an option.
.SH "SYNOPSIS"
.ft B
#include <transform.h>
.sp
int Trf_SetObjOption
.br
(
.br
	Trf_Options options,
.br
	Tcl_Interp *interp,
.br
	const char *optname,
.br
	const Tcl_Obj *optvalue,
.br
	ClientData clientData
.br
);
.ft R
.SH "PARAMETERS"
.TP
.B "Trf_Options options"
Container to place the value into.
.TP
.B "Tcl_Interp *interp"
Interpreter for error messages
(NULL possible).
.TP
.B "const char *optname"
Name of option to define.
.TP
.B "const Tcl_Obj *optvalue"
Value to set into the container.
.TP
.B "ClientData clientData"
Arbitrary information, as defined in
Trf_TypeDefinition.clientData.
.SH "DESCRIPTION"
The procedure takes the specified optionname (rejecting
illegal ones) and places the given optionvalue into the
container. All necessary conversions from a Tcl_Obj to the
required type should be done here. 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. This procedure makes sense for tcl
version 8 and above only.
.SH "SEE ALSO"
Trf_Init(3),
Trf_SafeInit(3),
Trf_IsInitialized(3),
Trf_CreateOptions(3),
Trf_DeleteOptions(3),
Trf_CheckOptions(3),
Trf_SetOption(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)