PathGet

InstallShield 2019 » InstallScript Language Reference

The PathGet function retrieves the search path currently stored in the path buffer, which is a temporary storage area created by a call to PathSet. The path buffer enables you to build and edit a search path. When the path you are editing is complete, call PathGet to place the search path into a string variable so that you can pass it to other functions in your setup.

This function has no relationship to the path statement in the Autoexec.bat file or the path environment variable. It acts on the path buffer only, which helps you build, modify, and manipulate search paths. You can then add this temporary path string to the Autoexec.bat file using the appropriate batch file functions.

Tip • PathGet retrieves the search path from the path buffer and releases the memory allocated to the path buffer. A subsequent call to PathGet will fail unless the path buffer is reinitialized by a call to PathSet.

Syntax

PathGet ( svString );

Parameters

PathGet Parameters

Parameter

Description

svString

Returns the contents of the path buffer.

Return Values

PathGet Return Values

Return Value

Description

0

Indicates that the function successfully retrieved the path currently stored in the path buffer.

< 0

Indicates that the function was unable to retrieve the path string currently stored in the temporary path string buffer.

See Also