SaveFile Method (RICHEDITTEXT)

9.0B, PLBCMP GUI Only

The SaveFile method stores the contents of a RICHEDITTEXT object into a file. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A RICHEDITTEXT object that is accessed.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

fname

Required. A Character String Variable or literal that specifies the file name.

options

Optional. A decimal number or Numeric Variable that specifies the load options.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. If the value returned is zero, the ZERO Condition Flag is set.

2. The OVER and EOS Condition Flags are always cleared.

3. When running under the PL/B Application Server, the first character of the file name has special meaning:

 

Value	The file ...
! (exclamation mark)	is saved on the client rather than the server.

 

4. The {options} value is a constant as defined in PLBMETH.INC or a numeric variable indicating one or more of the following option values:

 

Keyword	Value	Output as ...
$SF_TEXT	0x1	text with spaces in place of COM object
$SF_RTF	0x2	a RTF file
$SF_RTFNOOBJS	0x3	a RTF with spaces in place of COM object
$SF_TEXTIZED	0x4	text with a text representation of COM objects
$SF_UNICODE	0x10	a Unicode file
$SF_USECODEPAGE	0x20	CodePage given by high word
$SF_SELECTION	0x0800	output only the selection

 

5. A return value of zero (0) indicates success.

6. A return value of non-zero an error.

See Also: Example Code, Method Syntax, RICHEDITTEXT Methods