home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / NextLibrary / Documentation / Sybase / DBLIB / Section2 / dbcollen.nr < prev    next >
Encoding:
Text File  |  1993-04-22  |  1.1 KB  |  43 lines
  1. .Na "dbcollen" 
  2. .Aa
  3. .Fu
  4. Return the maximum length of the data in a regular result column.
  5. .Ih "column, maximum length for data in a"
  6. .Sy
  7. .Sf "DBINT dbcollen(dbproc, column)"
  8. .Sp "DBPROCESS" "*dbproc"
  9. .Sp "int" "column"
  10. .Co
  11. .Bl
  12. This routine returns the maximum length of the data in a 
  13. regular (\f2i.e.,\f1 non-compute) result column.  In the case of variable length data,
  14. this is not necessarily the actual length of the data, but rather the
  15. maximum length that the data can be.  For the actual data length, use
  16. .I "dbdatlen()."
  17. .Bl
  18. Here's a small program fragment that uses \f2dbcollen()\fP:
  19. .ta +4n +4n +4n +4n +4n +4n
  20. .SD
  21. .so dbcollen.ex
  22. .ED
  23. .Bz
  24. .Pa
  25. .Pi dbproc
  26. A pointer to the DBPROCESS structure that provides the connection
  27. for a particular front-end/\*S process.  It contains all the
  28. information that \*L uses to manage communications and data between the
  29. front end and \*S.
  30. .Pi column
  31. The number of the column of interest.  The first column is number 1.
  32. .in -.375i
  33. .Re
  34. .br
  35. The maximum length, in bytes, of the data for the particular column.
  36. If the column number is not in range, \f2dbcollen()\f1 returns -1.
  37. .Sa
  38. dbcolname,
  39. dbcoltype,
  40. dbdata,
  41. dbdatlen,
  42. dbnumcols
  43.