38,8 → 38,8 |
#define __NET_APP_PARSE__ |
|
/** Prints the parameter unrecognized message and the application help. |
* @param index The index of the parameter. Input parameter. |
* @param parameter The parameter name. Input parameter. |
* @param[in] index The index of the parameter. |
* @param[in] parameter The parameter name. |
*/ |
void print_unrecognized( int index, const char * parameter ); |
|
46,12 → 46,12 |
/** Parses the next parameter as an integral number. |
* The actual parameter is pointed by the index. |
* Parses the offseted actual parameter value if the offset is set or the next one if not. |
* @param argc The total number of the parameters. Input parameter. |
* @param argv The parameters. Input parameter. |
* @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter. |
* @param value The parsed parameter value. Output parameter. |
* @param name The parameter name to be printed on errors. Input parameter. |
* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter. |
* @param[in] argc The total number of the parameters. |
* @param[in] argv The parameters. |
* @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters. |
* @param[out] value The parsed parameter value. |
* @param[in] name The parameter name to be printed on errors. |
* @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. |
* @returns EOK on success. |
* @returns EINVAL if the parameter is missing. |
* @returns EINVAL if the parameter is in wrong format. |
62,12 → 62,12 |
* The actual parameter is pointed by the index. |
* Uses the offseted actual parameter value if the offset is set or the next one if not. |
* Increments the actual index by the number of processed parameters. |
* @param argc The total number of the parameters. Input parameter. |
* @param argv The parameters. Input parameter. |
* @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter. |
* @param value The parsed parameter value. Output parameter. |
* @param name The parameter name to be printed on errors. Input parameter. |
* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter. |
* @param[in] argc The total number of the parameters. |
* @param[in] argv The parameters. |
* @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters. |
* @param[out] value The parsed parameter value. |
* @param[in] name The parameter name to be printed on errors. |
* @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. |
* @returns EOK on success. |
* @returns EINVAL if the parameter is missing. |
*/ |
78,13 → 78,13 |
* Uses the offseted actual parameter if the offset is set or the next one if not. |
* Translates the parameter using the parse_value function. |
* Increments the actual index by the number of processed parameters. |
* @param argc The total number of the parameters. Input parameter. |
* @param argv The parameters. Input parameter. |
* @param index The actual parameter index. The index is incremented by the number of processed parameters. Input/output parameter. |
* @param value The parsed parameter value. Output parameter. |
* @param name The parameter name to be printed on errors. Input parameter. |
* @param offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. Input parameter. |
* @param parse_value The translation function to parse the named value. |
* @param[in] argc The total number of the parameters. |
* @param[in] argv The parameters. |
* @param[in,out] index The actual parameter index. The index is incremented by the number of processed parameters. |
* @param[out] value The parsed parameter value. |
* @param[in] name The parameter name to be printed on errors. |
* @param[in] offset The value offset in the actual parameter. If not set, the next parameter is parsed instead. |
* @param[in] parse_value The translation function to parse the named value. |
* @returns EOK on success. |
* @returns EINVAL if the parameter is missing. |
* @returns ENOENT if the parameter name has not been found. |