home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / LinkVar.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  4.6 KB  |  121 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/LinkVar.3,v 1.4 93/07/28 15:18:56 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) LinkVar.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_LinkVar tclc 7.0
  32. .BS
  33. .SH NAME
  34. .na
  35. Tcl_LinkVar, Tcl_UnlinkVar \- link Tcl variable to C variable
  36. .ad
  37. .SH SYNOPSIS
  38. .nf
  39. \fB#include <tcl.h>\fR
  40. .sp
  41. int
  42. \fBTcl_LinkVar\fR(\fIinterp, varName, addr, type\fR)
  43. .sp
  44. \fBTcl_UnlinkVar\fR(\fIinterp, varName\fR)
  45. .SH ARGUMENTS
  46. .AS Tcl_Interp writable
  47. .AP Tcl_Interp *interp in
  48. Interpreter that contains \fIvarName\fR.
  49. Also used by \fBTcl_LinkVar\fR to return error messages.
  50. .AP char *varName in
  51. Name of global variable.
  52. .AP char *addr in
  53. Address of C variable that is to be linked to \fIvarName\fR.
  54. .AP int type in
  55. .na
  56. Type of C variable.  Must be one of TCL_LINK_INT, TCL_LINK_DOUBLE,
  57. TCL_LINK_BOOLEAN, or TCL_LINK_STRING, optionally OR'ed with
  58. TCL_LINK_READ_ONLY to make Tcl variable read-only.
  59. .ad
  60. .BE
  61.  
  62. .SH DESCRIPTION
  63. .PP
  64. \fBTcl_LinkVar\fR uses variable traces to keep the Tcl variable
  65. named by \fIvarName\fR in sync with the C variable at the address
  66. given by \fIaddr\fR.
  67. Whenever the Tcl variable is read the value of the C variable will
  68. be returned, and whenever the Tcl variable is written the C
  69. variable will be updated to have the same value.
  70. \fBTcl_LinkVar\fR normally returns TCL_OK;  if an error occurs
  71. while setting up the link (e.g. because \fIvarName\fR is the
  72. name of array) then TCL_ERROR is returned and \fIinterp->result\fR
  73. contains an error message.
  74. .PP
  75. The \fItype\fR argument specifies the type of the C variable,
  76. and must have one of the following values, optionally OR'ed with
  77. TCL_LINK_READ_ONLY:
  78. .TP
  79. \fBTCL_LINK_INT\fR
  80. The C variable is of type \fBint\fR.
  81. Any value written into the Tcl variable must have a proper integer
  82. form acceptable to \fBTcl_GetInt\fR;  attempts to write
  83. non-integer values into \fIvarName\fR will be rejected with
  84. Tcl errors.
  85. .TP
  86. \fBTCL_LINK_DOUBLE\fR
  87. The C variable is of type \fBdouble\fR.
  88. Any value written into the Tcl variable must have a proper real
  89. form acceptable to \fBTcl_GetDouble\fR;  attempts to write
  90. non-real values into \fIvarName\fR will be rejected with
  91. Tcl errors.
  92. .TP
  93. \fBTCL_LINK_BOOLEAN\fR
  94. The C variable is of type \fBint\fR.
  95. If its value is zero then it will read from Tcl as ``0'';
  96. otherwise it will read from Tcl as ``1''.
  97. Whenver \fIvarName\fR is
  98. modified, the C variable will be set to a 0 or 1 value.
  99. Any value written into the Tcl variable must have a proper boolean
  100. form acceptable to \fBTcl_GetBoolean\fR;  attempts to write
  101. non-boolean values into \fIvarName\fR will be rejected with
  102. Tcl errors.
  103. .TP
  104. \fBTCL_LINK_STRING\fR
  105. The C variable is of type \fBchar *\fR.
  106. If its value is not null then it must be a pointer to a string
  107. allocated with \fBmalloc\fR.
  108. Whenever the Tcl variable is modified the current C string will be
  109. freed and new memory will be allocated to hold a copy of the variable's
  110. new value.
  111. If the C variable contains a null pointer then the Tcl variable
  112. will read as ``NULL''.
  113. .PP
  114. If the TCL_LINK_READ_ONLY flag is present in \fItype\fR then the
  115. variable will be read-only from Tcl, so that its value can only be
  116. changed by modifying the C variable.
  117. Attempts to write the variable from Tcl will be rejected with errors.
  118.  
  119. .SH KEYWORDS
  120. boolean, integer, link, read-only, real, string, variable
  121.