PfsHelper Methods |
The PfsHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | PfsAddSection |
Start a new section within the scope of a target.
|
| PfsAddTarget |
Add a new target (top-level section) to a parameter file object.
|
| PfsClose |
Terminate the access to a parameter file data structure and free the associated internal storage.
|
| PfsCreate |
Create an empty parameter structure to be used for writing a parameter file, or for creating a parameter definition.
|
| PfsEndSection |
Terminate a target or a section.
|
| PfsGetClobItem |
Get the next Clob parameter as a PFSParameter handle,
where you can query it for the type of parameter data.
|
| PfsGetDouble(IntPtr) |
Return the double (8-byte double precision floating point) value from the pfsNode (parameter) passed as argument.
|
| PfsGetDouble(IntPtr, Int32) |
Return the double (8-byte double precision floating point) value from the keyword name passed as argument.
|
| PfsGetErrMsg |
This method is a combination of pfsGetErrorGlb and pfsGetErrorMessageFromErrorCode
|
| PfsGetErrMsgFromPfsClob |
Extract erroe message from a pfs clob
|
| PfsGetKeyword |
Returns a reference to the n'th instance of a specific keyword name of the pfsNode (target/section) passed as argument.
|
| PfsGetKeywordNum |
Return the number of keywords connected to the pfsNode passed as argument
|
| PfsGetParam(IntPtr, Int32) |
Return a reference to the n'th parameter of the pfsNode (keyword) passed as argument.
|
| PfsGetParam(IntPtr, String, Int32, Int32) |
Returns a reference to the m'th parameter of the n'th instance of a specific keyword name of the pfsNode (target/section) passed as argument.
|
 | PfsGetSection(IntPtr, Int32) |
Return a reference to the n'th section of the pfsNode (target/section) passed as argument.
|
| PfsGetSection(IntPtr, String, Int32) |
Returns a reference to the n'th instance of a specific subsection name of the pfsNode (target/section) passed as argument.
|
| PfsGetSectionByHandler |
Returns the section specified in the sectionPath parameter
|
| PfsGetTarget |
Return a reference to the n'th instance of a specific target name of a parameter file.
|
| PfsIsBool |
Indicates if the pfsNode passed as argument refers to a string value.
|
| PfsIsDouble |
Indicates if the pfsNode passed as argument refers to a double (8-byte double precision floating point) parameter value.
|
| PfsIsFilename |
Return true of the node is a filename
|
| PfsIsFloat |
Indicates if the pfsNode passed as argument refers to a float (4-byte single precision floating point) parameter value.
|
| PfsIsInt |
Indicates if the pfsNode passed as argument refers to an integer parameter value.
|
| PfsIsString |
Indicates if the pfsNode passed as argument refers to a string value.
|
| PfsLoadFile |
Open an existing parameter file and create an internal data structure for further processing.
|
| PfsReadClobT |
Read T valued data from clob
|
| PfsReadClobFilename |
Extract a Filename from current CLOB
|
| PfsReadFilename(IntPtr) |
Get the filename from the node
|
| PfsReadFilename(IntPtr, String, Int32, Int32, String) |
Return the filename of paramNo'th parameter of keywordNo'th keyword of the keyword in pfsSect
|
| PfsReadParamT(IntPtr, T) |
Return T typed value from the given pointer to parameter
|
| PfsReadParamT(IntPtr, String, Int32) |
Return all parameters as a T typed array of the given keyword name and index
|
| PfsReadParamT(IntPtr, String, Int32, Int32, T) |
Return the T typed value of paramNo'th parameter of keywordNo'th keyword of the keyword in pfsSect
|
| PfsReadString |
Return a string value of the pfsNode (parameter) passed as argument.
|
| PfsWrite |
Write the contents of a parameter file object using the parameter file syntax
|
| PfsWriteClob(IntPtr, Boolean, Object) |
Write all values in the array to the clob
|
| PfsWriteClob(IntPtr, String, Object) |
Write all values in the array to the clob in the created keyword
|
| PfsWriteClobFilename(IntPtr, Boolean, String) |
Write filename to the clob
|
| PfsWriteClobFilename(IntPtr, String, String) |
Write filename to the clob in the new created keyword
|
| PfsWriteFilename(IntPtr, String) |
Write a null-termindated character string to keyword
Restrictions: The function is only valid within the scope of a keyword. In a Pascal program, the use of null-terminated strings must be enforced using a compiler option. |
| PfsWriteFilename(IntPtr, String, String) |
Write a null-termindated character string to section
Restrictions: The function is only valid within the scope of a section. |
| PfsWriteKeyword |
Write all values in the array to the keyword
|
| PfsWriteParams |
Write all values in the array to the parameter
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also