Child pages
  • cPanel API 1 Functions - UI::showresult
Skip to end of metadata
Go to start of metadata

Description

This function prints a function's results within div tags.

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.
$ui_display = $cpanel->api1('UI','showresult', array('resultkey') ); // 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 $ui_display = $cpliveapi->api1('UI','showresult', ['resultkey'] ); # 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. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="UI::showresult( $FORM('resultkey'))">
 Command Line
cpapi1 --user=username UI showresult $Cpanel::Form


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.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (HTML)
<div>The contents of the result form data parameter</div>

   

Parameters

ParameterTypeDescriptionPossible valuesExample

resultkey

string

Required

The name of the function for which to display results.

 

A valid $Cpanel::Form value.

Note:

  • This value must match the $Cpanel::FORM value for the same name.
  • You must call the function with the same form variable name.
$Cpanel::Form

Form Data

ParameterTypeDescriptionPossible valuesExample
errorBooleanWhether to display div class errors or the function's results.
  • 1 — Display div class errors.
  • 0 — Display result of the function.
0
resultstringThe parameter to display in the output.A string value.The contents of the result form data parameter.
resultkeystring

The name of the function for which to display results.

A valid $Cpanel::Form value.$Cpanel::Form


Returns

This function returns the result form parameter, in div tags.