cPanel API 1 Functions - Fileman::viewfile

Description

This function displays a file.

Warning:

cPanel API 1 is deprecatedDo not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples


 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
$view_file $cpanel->api1('Fileman''viewfile'array('public_html''myfile')); // Call the function.

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $view_file $cpliveapi->api1('Fileman''viewfile' ['public_html''myfile']); # Call the function.

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

 

<cpanel Module="Fileman::viewfile ( $FORM('dir','file'))">

 Command Line

cpapi1 --user=username Filename viewfile dir=public_html file=myfile

 

Notes:

  • You must URI-encode these values.
  • username represents your account-level username.

 Output (HTML)

<img src="images/gnome-textfile.gif"> <b><font size=+1>test.txt</font></b>
 <br>File Type: ASCII text


Parameters

 Parameter 

Type

Description

Possible values

 Example 

 dir

 string 

 Required

 The file's directory. 

 Any valid directory name. 

 user

 file

 string

 Required

 The file.

 Any valid filename

 myfile

 

Returns

This function returns HTML that displays the file's properties.

 

 

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....