Description

This function saves a string's contents to a file.


Examples




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$save_string = $cpanel->api1('Fileman', 'fmsavefile', array('user', 'myfile.txt', 'This is the new string', '1', '1')); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $save_string = $cpliveapi->api1('Fileman', 'fmsavefile' ['user', 'myfile.txt', 'This is the new string', '1', '1']); # Call the function.


<cpanel Module="Fileman::fmsavefile ( $FORM('dir','file','page','doublecode','stripnewline'))">




cpapi1 --user=username Fileman fmsavefile user myfile.txt "This is the new string" 1 1


This function does not return output.



Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The file's directory.

Any valid directory, relative to the account's /home directory.user
filestring

Required

The file to modify.

Any valid filename.myfile.txt
pagestring

Required

The new string to save.

Any string.This is the new string.
doubledecodeBoolean

Required

Whether to decode the URL values in the specified directory and file.

  • 0 — Do not decode.
  • 1 — Decode.
0
stripnewlineBoolean

Required

Whether to strip new lines in the file.

  • 0 — Do not strip.
  • 1 — Strip.
1

Returns

This function does not return output.