Page tree
Skip to end of metadata
Go to start of metadata

Description

This function initiates a ClamAV virus scan.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$display_bars = $cpanel->api1('ClamScanner', 'bars', array('10') ); // Call the function.

Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $display_bars = $cpliveapi->api1('ClamScanner', 'bars', ['10'] ); # Call the function.

Note:

For more information, read our Guide to the LiveAPI System.

 

 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="ClamScanner::bars( $FORM('bars') )">
 Command Line
cpapi1 --user=username ClamScanner bars 10

Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (plaintext)
<img src=blank.gif width=2 height=31>
<img src=bar.gif width=12 height=31>
<img src=blank.gif width=2 height=31>
<img src=bar.gif width=12 height=31>
<img src=blank.gif width=2 height=31>
<img src=bar.gif width=12 height=31>

 

Parameters

ParameterTypeDescriptionPossible valuesExample
bars

integer

Required

The number of segments in the progress bar.

A positive integer that represents the number of segments in the progress bar.

For example, a value of 10 causes the progress bar to measure completion in 10% (100% divided by 10) increments.

Note:

The larger this value, the more precise the overall progress bar.

10

Returns

The function starts the virus scan and then displays a progress bar.