Description

This function returns the height of an image in pixels.

Examples 




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_hdimension = $cpanel->api1('ImageManager','hdimension',array('images','image.jpg')); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $image_hdimension = $cpliveapi->api1('ImageManager','hdimension',['images','image.jpg'] ); # Call the function.

 


<cpanel Module="ImageManager::hdimension($FORM('dir','file'))">




cpapi1 --user=username ImageManager hdimension images image.jpg



700




Parameters

ParameterTypeDescriptionPossible ValuesExample
dirstring

Required

The directory that contains the file to measure.

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

Required

The name of the file to measure.

A valid filename.image.jpg

Returns

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