GetDir Method (RUNTIME)

PLB Web Only, 9.7

The GetDir method retrieves the directories that are currently in use for a PL/B runtime. This method has been added to support COPYFILE execution in the PL/B Web Server environment. The method uses the following format:

[label]

{object}.GetDir

[GIVING {return}] USING [*Type=]{dirtype}

Where:

label

Optional. A Program Execution Label.

object

Required. A RUNTIME object.

return

Optional. A Character String Variable that receives the current directory name and path being used by the RUNTIME object.

type

Required. A Numeric variable or decimal number that identifies the specific RUNTIME directory type to be returned.

Flags Affected: EOS, OVER, ZERO

Note the following:

The EOS flag is set TRUE if the {return} Character String variable is too small to receive the directory data without being truncated.
The ZERO and OVER flags are always cleared.
The {dirtype} values define the type of directory information to be returned:

Type Value	Returns...
0	the current working directory.
1	the directory specified by the PLBWEB_PROGRAM_ROOT keyword. If this keyword is not specified, a NULL string is returned.
2	If a client browser logs on using a SSL connection, this directory supports that connection. The directory specified by the PLBWEB_SSL_PROGRAM_ROOT is returned when it exists. If the PLBWEB_SSL_PROGRAM_ROOT does not exist, the PLB_PROGRAM_ROOT keyword is returned.
3	the directory specified by the PLBWEB_ROOT keyword. If this keyword is not specified, a NULL string is returned.
4	If a client browser logs on using a SSL connection, this directory supports that connection. The directory specified by the PLBWEB_SSL_ROOT keyword is returned if it exists. If the PLBWEB_SSL_ROOT does not exist, the PLBWEB_ROOT keyword is returned.
5	the directory specified by the PLBWEB_SAVETOCLIENT keyword. If this keyword is not used, the returned value is the 'savetoclient' relative directory name.
6	the directory specified by the PLBWEB_UPLOADS keyword. If this keyword is not used, the returned value is the 'uploads' directory.

See Also: RUNTIME, RUNTIME Methods, Method Syntax