home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume29 / parseargs / part01 / doc / parsecntl3.inc < prev    next >
Encoding:
Text File  |  1992-05-19  |  1.7 KB  |  45 lines
  1. .\"----------------------------------------------------------------------------
  2. .\"-- This text was extracted using the following command:
  3. .\"--   xdoc -man -n -p '[ \t]*' -I DESCRIPTION -f parsecntl ../xparse.c
  4. .\"----------------------------------------------------------------------------
  5. .SH "DESCRIPTION"
  6. .PP
  7. .I Parsecntl
  8. will read and/or write the desired attributes of the given
  9. command-object. The attributes to be operated upon are specified by
  10. the second parameter to
  11. .I parsecntl.
  12. The desired mode (read, write, or both) are specified by the third parameter to
  13. .I parsecntl.
  14. If the operation to be performed is
  15. .I pc_\s-1ARGFLAGS\s+1,
  16. then the fourth argument to
  17. .I parsecntl
  18. should be the keyword name of the argument whose flags
  19. are to be retrieved.  The last parameter to
  20. .I parsecntl
  21. is always the object to contain the attribute(s) to be read/written.
  22. If the attribute(s) are to be read (regardless of whether or not they are 
  23. also being changed) then the last argument should be a pointer to
  24. an object, otherwise the last argument should be the object itself.
  25. .PP
  26. If mode is
  27. .I pc_\s-1READ\s+1,
  28. then the desired attributes are copied into
  29. the object pointed to by the last parameter. If the mode is
  30. .I pc_\s-1WRITE\s+1,
  31. then the attributes from the last parameter are copied to the
  32. command-object. If mode is
  33. .I pc_\s-1RDWR\s+1,
  34. then the attributes pointed to by the last
  35. parameter are copied to the command-object, and then the previous value
  36. of these attributes (before they were overwritten) is copied into the
  37. object pointed to by the last parameter.
  38. .PP
  39. If cntl is
  40. .I pc_\s-1ARGFLAGS\s+1,
  41. then the only valid mode is
  42. .I pc_\s-1READ\s+1.
  43. All other attributes may be written or read by
  44. .I parsecntl.
  45.