Cpanel::SubDomain::delsubdomain

This article documents the usage of the Cpanel::SubDomain::delsubdomain function in relation to the cPanel interface. This tag can be used inside cPanel pages.


SYNOPSIS

Cpanel::SubDomain::delsubdomain


DESCRIPTION

This function will delete a specified subdomain and output the result of the deletion and a reason for failure, if any.


VARIABLES

INPUT

domain (string)
Name of the subdomain. Format: sub.domain.com

OUTPUT

result
Result of the deletion.

reason
Reason for failure of the operation, if any.


EXAMPLES

<?cp SubDomain::delsubdomain(% %,result,reason) domain=$FORM{'domain'} ?>

This example will delete a subdomain specified in a form and output the result of the deletion and a reason for failure, if any.


COPYRIGHT

Copyright 2007 cPanel Inc.