summaryrefslogtreecommitdiff
path: root/libs/cargs/docs/reference/cag_option_print.md
blob: c4531ebc7a24ed16d710a179552a82c6db8137e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
---
title: cag_option_print
description: Prints all options to the terminal.
---

_(since v1.0.0)_  
description: Prints all options to the terminal.

## Description
```c
void cag_option_print(const cag_option *options, size_t option_count,
  FILE *destination);
```

This function prints all options to the terminal. This can be used to generate
the output for a "--help" option.
 
## Parameters
 * **options**: The options which will be printed.
 * **option_count**: The option count which will be printed.
 * **destination**: The destination where the output will be printed.


## Changelog

| Version    | Description                                            |
|------------|--------------------------------------------------------|
| **v1.0.0** | The function is introduced.                            |