cake
/
libg1m
Archived
1
0
Fork 0
This repository has been archived on 2024-03-16. You can view files and clone it, but cannot push or open issues or pull requests.
libg1m/doc/g1m_open.3.txt

42 lines
720 B
Plaintext

G1M_OPEN(3)
=========
Thomas "Cakeisalie5" Touhey
:Email: thomas@touhey.fr
:man source: libg1m
:man manual: libg1m manual
NAME
----
g1m_open, g1m_fopen - open and decode a file
SYNOPSIS
--------
[source,c]
----
#include <libg1m.h>
int g1m_open(g1m_t **handle, const char *path);
int g1m_fopen(g1m_t **handle, FILE *stream);
----
DESCRIPTION
-----------
Open and decode a file. If everything goes well, the handle is stored at
**handle*.
For *g1m_fopen*, the stream only requires reading (writing and seeking
capabilities are not required).
RETURN VALUE
------------
This function returns zero if everything went well, and the error code
otherwise.
ERRORS
------
See *g1m_error*(3).
SEE ALSO
--------
*libg1m*(3)