PATH function

Synopsis

This function returns a string representing the full path of the specified special folder (predefined folder). On certain Windows-based platforms, legacy projects might have used the PATH function with other special folder names.

Remarks

For information on working with file paths, including determining whether a path will be accessed on your runtime platform or on your development computer, see the Specifying a path section in Appendix A: Expression syntax.
Note that this function does not consider the input in which it is used when it returns a path. It only considers whether it is being run at design-time or runtime. This might lead to unintended behavior, including errors that occur at design-time but do not occur at runtime. For example, if you use this function with "DA Install" or "DA Project", it will always evaluate to a Windows path on the development computer when executed at design-time. This is true even if your runtime platform is a Matrox smart camera running MIOS and the function is used in a step input that accesses the specified path on your runtime platform. Attempting to access a Windows path on a MIOS system will generate an error.

Variations

PATH(SpecialFolderName)

Returns the path of the specified special folder.

Details | Examples | Details and examples

Parameters

SpecialFolderName

Specifies the special folder name as a string.

This parameter can be set to one of the following (must be in quotation marks):

Value	Description
"DA Documents"	Returns the path of the Matrox Design Assistant documents folder on the runtime platform.
"DA Install"	Returns the path of the Matrox Design Assistant installation folder on the development computer (at design-time) or on the runtime platform (at runtime). This setting is typically used to access the preinstalled example images at design-time. (summarize) Returns the path of the Matrox Design Assistant installation folder on the development computer (at design-time) or on the runtime platform (at runtime). (more details...)
"DA Project"	Returns the path of the folder containing the project files on the development computer (at design-time) or on the runtime platform (at runtime). This setting is typically used to access the preinstalled example images at design-time. (summarize) Returns the path of the folder containing the project files on the development computer (at design-time) or on the runtime platform (at runtime). (more details...)

Supported types: String.

Returns

Returned types: String.

Examples

1.	The following example returns the path of the Matrox Design Assistant documents folder. Under Windows the default is C:\Users\username\My Documents\Matrox Design Assistant . Under MIOS the default is /home/mtxuser/Documents/Matrox Design Assistant . {PATH("DA Documents")}
2.	The following example returns the path of the Matrox Design Assistant installation folder. Under Windows the default is C:\Program Files\Matrox Imaging\DA 6.0. Under MIOS the default is /opt/matrox_imaging/DA6.0 . {PATH("DA Install")}
3.	The following example returns the path of the folder containing your project. The default path for the BlobAnalysis example project under Windows is C:\Users\Public\Public Documents\Matrox Imaging\DA 6.0 \Example Projects\BlobAnalysis . The default path for the BlobAnalysis example project under MIOS is /var/lib/matrox_design_assistant/ 6.0 /Projects/BlobAnalysis. {PATH("DA Project")}