Click or drag to resize
PFSParameter Methods

The PFSParameter type exposes the following members.

Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetInstanceNo Obsolete.
Internal method, for testing/debugging only
Public methodGetSyntaxClass Obsolete.
Internal method, for testing/debugging only
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsBool
Check if this parameter is a boolean parameter
Public methodIsClob
Check if this parameter is a Blob parameter
Public methodIsDouble
Check if this parameter is a double parameter
Public methodIsFilename
Check if this parameter is a filename parameter
Public methodIsInt
Check if this parameter is an integer parameter
Public methodIsSingle
Check if this parameter is a single parameter
Public methodIsString
Check if this parameter is a string parameter
Public methodIsUndefined
Check if this parameter is an undefined parameter
Public methodModifyBoolParameter
Modify the value of this parameter, if it is bool type
Public methodModifyDoubleParameter
Modify the value of this parameter, if it is double type
Public methodModifyFileNameParameter
Modify the value of this parameter, if it is File Name type
Public methodModifyIntParameter
Modify the value of this parameter, if it is int type
Public methodModifyStringParameter
Modify the value of this parameter, if it is string type
Public methodToBoolean
Get the Boolean value of the parameter
Public methodToClob
Get the Clob object from the parameter.

If this parameter is not a Clob parameter, an exception is thrown.

Public methodToDouble
Get the double value of the parameter

If this parameter is not a double parameter, an exception is thrown.

Public methodToFileName
Get the file name value of the parameter. The returned string is the value as entered in the PFS file, i.e. path can be relative

If this parameter is not a file name parameter, an exception is thrown.

Public methodToFileNamePath
Get a string with the filename and path. The returned string will contain the full path to the file. In case the file name string is relative, the path of the pfs file is used as base path to create a full path string.

If this parameter is not a file name parameter, an exception is thrown.

Public methodToInt
Get the integer value of the parameter

If this parameter is not an integer parameter, an exception is thrown.

Public methodToResultFileName
Get the string or filename value as result-filename.

A convenience method that for a string returns ToString and for a filename returns ToFileName

Public methodToResultFileNamePath
Get the result file name path.

The result file name path for relative file name strings depends on whether the underlying pfs parameter is a filename parameter or a string parameter.

For a filename parameter, the result file folder is the folder of the pfs file, and a relative file name string is relative to the pfs file location.

For a string parameter, the result file folder is taken into consideration when creating the path. The result file folder is either the default "pfsFile.pfs - Result Files\", the project defined output folder or the custom defined output folder.

The result file name path is always absolute.

Public methodToSingle
The the single (float) value of the parameter

If this parameter is not a single/double parameter, an exception is thrown.

Public methodToString
Get the string value of the parameter.

If this parameter is not a string parameter, an exception is thrown.

(Overrides ObjectToString.)
Top
See Also