home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / pini10 / pini.doc < prev    next >
Encoding:
Text File  |  1995-01-07  |  2.4 KB  |  57 lines
  1. PINI.BAS documentation file
  2.  
  3. This software is Freeware.  Please distribute freely.
  4.  
  5. This software has no warranties either expressed or implied.  If you use
  6. it, you assume all responsibilities for any damage done to any hardware or
  7. software.  The author can not be held responsible for any damaged incurred.
  8.  
  9. I wrote this module after finding VBX's that did the same thing but had a
  10. 'nag' screen on them.  Also, they wanted $8 or more to register them.  I
  11. thought "Why pay for a VBX when I can write a module to do the same thing
  12. in a couple hours or so."  Well, as it turned out it took less than an hour
  13. and surprisingly few lines of code.
  14.  
  15. PINI stands for Private INI.  Windows has two similar calls, one to
  16. read/write the WIN.INI file, and another to read/write all other INI files.
  17. GetProfileString is used on the WIN.INI file, and GetPrivateProfileString is
  18. used on all other INI files.  The main difference between the two functions
  19. is you don't specify a filename with the first function because WIN.INI is
  20. implied.  You need to supply the name of the INI file in the second one.
  21. My module works with both, simply specify "WIN.INI" as the file name.
  22.  
  23. PINI has three functions:     ReadPINIInt: reads an integer
  24.                            ReadPINIString: reads a string
  25.                           WritePINIString: writes a string
  26.  
  27.   These functions are detailed as follows:
  28.  
  29.      Syntax: ReadPINIInt(iniFile,iniSection,iniEntry)
  30.     Returns: Integer value
  31.     Example: ReadPINIInt("WIN.INI","Desktop","IconSpacing")
  32.      Result: 75
  33.  
  34.      Syntax: ReadPINIString(iniFile,iniSection,iniEntry)
  35.     Returns: String value
  36.     Example: ReadPINIInt("WIN.INI","Windows","Device")
  37.      Result: "HP LaserJet Series II,HPPCL,LPT1:"
  38.  
  39.      Syntax: WritePINIString(iniFile,iniSection,iniEntry,iniString)
  40.     Returns: Integer, non-zero if successfull, 0 if not successfull
  41.     Example: ReadPINIInt("PINI","Testing","1...2...3...")
  42.      Result: -1
  43.  
  44. I haven't tested this module extensively.  If you find any bugs or have any
  45. suggestions for this or other modules please call, write, or Email me at:
  46.  
  47.   Written by: Tim Berneman
  48.               7203 Forest Court
  49.               Des Moines, IA  50311-1329
  50.               (515)255-5056
  51.  
  52.            1) tim.berneman@swcbbs.com    (Please try in this order)
  53.            2) vision@dsmnet.com
  54.            3 )vision@visionary.com
  55.  
  56. End of PINI.BAS documentation file
  57.