Child pages
  • cPanel API 1 Functions - ImageManager::wdimension

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function returns the width of an image in pixels.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_wdimension = $cpanel->api1('ImageManager','wdimension',array('images','image.jpg')); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $image_wdimension = $cpliveapi->api1('ImageManager','wdimension',['images','image.jpg'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="ImageManager::wdimension($FORM('dir','file'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username ImageManager wdimension images image.jpg

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (plaintext)
Code Block
700

   

Parameters

ParameterTypeDescriptionPossible ValuesExample
dirstring

Required

The directory that contains the file to measure.

A valid directory path, relative to the cPanel account's home directory.
images
filestring

Required

The name of the file to measure.

A valid filename.image.jpg

Returns

This function returns the width of the image file, in pixels.