---
name: "rte_argparse_arg"
section: "3"
platform: "linux"
package: "dpdk-doc"
version: "24.11.4-0+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rte_argparse_arg"
---

# rte\_argparse\_arg(3)

## NAME

rte\_argparse\_arg

## SYNOPSIS

`#include <rte_argparse.h>`

### Data Fields

const char \* **name\_long**\
 const char \* **name\_short**\
 const char \* **help**\
 void \* **val\_saver**\
 void \* **val\_set**\
 uint64\_t **flags**\

## Detailed Description

A structure used to hold argument's configuration.

Definition at line **83** of file **rte\_argparse.h**.

## Field Documentation

### const char\* name\_long

Long name of the argument: 1) If the argument is optional, it must start with `--`. 2) If the argument is positional, it must not start with `-`. 3) Other case will be considered as error.

Definition at line **90** of file **rte\_argparse.h**.

### const char\* name\_short

Short name of the argument: 1) This field could be set only when name\_long is optional, and must start with a hyphen (-) followed by an English letter. 2) Other case it should be set NULL.

Definition at line **97** of file **rte\_argparse.h**.

### const char\* help

Help information of the argument, must not be NULL.

Definition at line **100** of file **rte\_argparse.h**.

### void\* val\_saver

Saver for the argument's value. 1) If the filed is NULL, the callback way is used for parsing argument. 2) If the field is not NULL, the autosave way is used for parsing argument.

Definition at line **109** of file **rte\_argparse.h**.

### void\* val\_set

If val\_saver is NULL, this filed (cast as (uint32\_t)val\_set) will be used as the first parameter to invoke callback.

If val\_saver is not NULL, then: 1) If argument has no value, \*val\_saver will be set to val\_set. 2) If argument has optional value but doesn't take value this time, \*val\_saver will be set to val\_set. 3) Other case it should be set NULL.

Definition at line **120** of file **rte\_argparse.h**.

### uint64\_t flags

Flag definition (RTE\_ARGPARSE\_ARG\_\*) for the argument.

Definition at line **123** of file **rte\_argparse.h**.

## Author

Generated automatically by Doxygen for DPDK from the source code.