NAME
Apache::Command - Perl API for XXX
Synopsis
use Apache::Command ();META: to be completed
Description
META: to be completed
API
Apache::Command provides the following functions and/or methods:
check_cmd_context
META: Autogenerated - needs to be reviewed/completed
$ret = $cmd->check_cmd_context($forbidden);- obj:
$cmd(Apache::CmdParms) -
The command to check
- arg1:
$forbidden(XXX) -
Where the command is forbidden.
- ret:
$ret(string) -
Error string on error, NULL on success
soak_end_container
META: Autogenerated - needs to be reviewed/completed
Read all data between the current <foo> and the matching </foo>. All of this data is forgotten immediately.
$ret = $cmd->soak_end_container($directive);- obj:
$cmd(Apache::CmdParms) -
The cmd_parms to pass to the directives inside the container
- arg1:
$directive(string) -
The directive name to read until
- ret:
$ret(string) -
Error string on failure, NULL on success
next
META: Autogenerated - needs to be reviewed/completed
$ret = $cmd->next();- obj:
$cmd(Apache::Command) - ret:
$ret(Apache::Command)
name
META: Autogenerated - needs to be reviewed/completed
Name of this command
$obj->name($newval);- obj:
$obj(Apache::Command) - arg1:
$newval(string) - ret: no return value
cmd_data
META: Autogenerated - needs to be reviewed/completed
Extra data, for functions which implement multiple commands...
$obj->cmd_data($newval);- obj:
$obj(Apache::Command) - arg1:
$newval(XXX) - ret: no return value
req_override
META: Autogenerated - needs to be reviewed/completed
What overrides need to be allowed to enable this command.
$obj->req_override($newval);- obj:
$obj(Apache::Command) - arg1:
$newval(integer) - ret: no return value
args_how
META: Autogenerated - needs to be reviewed/completed
What the command expects as arguments
$obj->args_how($newval);- obj:
$obj(Apache::Command) - arg1:
$newval(integer) - ret: no return value
errmsg
META: Autogenerated - needs to be reviewed/completed
'usage' message, in case of syntax errors
$obj->errmsg($newval);- obj:
$obj(Apache::Command) - arg1:
$newval(string) - ret: no return value
See Also
Copyright
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.