PEAR Manual
Prev |  | Next

# Net_Ping::setArgs()

Net_Ping::setArgs() -- set arguments for a ping command

## Synopsis

    require_once 'Net/Ping.php';

``boolean Net_Ping::setArgs` (array $args)`

## Description

Set the arguments for a ping command

## Parameter

- `array $args` - an array of the arguments to set

  Table 48-1. possible array keys

  Key name | Description | NOT supported on
  --- | --- | ---
  "count" | Number of ping packages to send |
  "quiet" | Level of output verbosity | Windows
  "iface" |  | FreeBSD, Linux, Windows
  "ttl" |  |
  "timeout" | Time to wait for a ACK of a ping package |
  "size" | Size of a ping package | FreeBSD, Darwin, Linux, Windows

## Return value

`boolean` - Returns `TRUE` on success, PEAR_Error on failure.

## Throws

Table 48-2. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | `PING_INVALID_ARGUMENTS` | A not supported argument was given | Check typing of argument (key name) and OS-support of the argument.

## Note

This function can not be called statically.

Prev | Home | Next
Net_Ping::ping() | Up | Net_POP3