DOCERR: PrependToPath Documented Incorrectly

 Last reviewed: July 23, 1997
Article ID: Q93396
3.10 WINDOWS kbtoolkbtoolg kbdocerr

The information in this article applies to:

  • Microsoft Windows Software Development Kit (SDK) for Windows version 3.1

The PrependToPath subroutine from the Setup toolkit is incorrectly documented in the Setup toolkit's README.WRI file. The arguments to the subroutine should not be enclosed in parentheses. PrependToPath is a subroutine and, unlike functions, the arguments to subroutines are never put in parentheses.

The syntax of the PrependToPath call is: 

   PrependToPath szSrc$, szDest$, szDir$, cmo%
An example of a call to PrependToPath is: 

   PrependToPath "c:\autoexec.bat","c:\autoexec.new","c:\tmp",cmoVital
szSrc$ is the full path of the original file. szDest$ is the name of new file created, which has the contents of the szSrc$ file with szDir$ added to the PATH statements. szSrc$ and szDest$ should not be the same. You can use the Setup function RenameFile to rename the original AUTOEXEC.BAT to a backup filename, and then again to rename the new file (AUTOEXEC.NEW in the code above) to AUTOEXEC.BAT.

Additional reference words: 3.10 MsSetup tool kit docerr
KBCategory: kbtool kbprg kbdocerr
KBSubcategory: TlsMss
Keywords : kb16bitonly

THE INFORMATION PROVIDED IN THE MICROSOFT KNOWLEDGE BASE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. MICROSOFT DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL MICROSOFT CORPORATION OR ITS SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF MICROSOFT CORPORATION OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES SO THE FOREGOING LIMITATION MAY NOT APPLY.

Last reviewed: July 23, 1997
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.