home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / usenet / altsrcs / 0 / 0998 / Merge.3 < prev    next >
Text File  |  1990-12-28  |  1KB  |  42 lines
  1. '\" Copyright 1989 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/lib/tcl/RCS/Tcl_Merge.man,v 1.2 89/03/24 14:16:16 ouster Exp $ SPRITE (Berkeley)
  10. '\" 
  11. .so \*(]ltmac.sprite
  12. .HS Tcl_Merge tcl
  13. .BS
  14. .SH NAME
  15. Tcl_Merge \- generate a Tcl list from a collection of strings
  16. .SH SYNOPSIS
  17. .nf
  18. \fB#include <tcl.h>\fR
  19. .sp
  20. char *
  21. \fBTcl_Merge\fR(\fIargc, argv\fR)
  22. .SH ARGUMENTS
  23. .AP int argc in
  24. Number of strings.
  25. .AP char *argv[] in
  26. Array of strings to combine into list.  Must have \fIargc\fR entries.
  27. .BE
  28.  
  29. .SH DESCRIPTION
  30. .PP
  31. \fBTcl_Merge\fR is a utility procedure used by several of the Tcl commands.
  32. Given a collection of strings, it generates a result string
  33. that has proper list structure, such that the \fBindex\fR
  34. Tcl command may be used to extract out the original strings.
  35. In order to do this, \fBTcl_Merge\fR may have to add braces
  36. and/or backslashes.  The result string is dynamically allocated
  37. using \fBmalloc()\fR;  the caller must eventually release the space
  38. using \fBfree()\fR.
  39.  
  40. .SH KEYWORDS
  41. list, strings
  42.