blob: c9aa9e5300753f1c7521a13c1fdc3b5037dfddcc (
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
29
30
|
---
title: cag_option_prepare
description: Prepare argument options context for parsing.
---
_(since v1.0.0)_
Prepare argument options context for parsing.
## Description
```c
void cag_option_prepare(cag_option_context *context, const cag_option *options,
size_t option_count, int argc, char **argv);
```
This function prepares the context for iteration and initializes the context
with the supplied options and arguments. After the context has been prepared,
it can be used to fetch arguments from it.
## Parameters
* **context**: The context which will be initialized.
* **options**: The registered options which are available for the program.
* **option_count**: The amount of options which are available for the program.
* **argc**: The amount of arguments the user supplied in the main function.
* **argv**: A pointer to the arguments of the main function.
## Changelog
| Version | Description |
|------------|--------------------------------------------------------|
| **v1.0.0** | The function is introduced. |
|
