version 1.3, 2016/02/20 02:43:42 |
version 1.4, 2021/03/08 20:55:06 |
|
|
.\" out of the use of this software, even if advised of the possibility of |
.\" out of the use of this software, even if advised of the possibility of |
.\" such damage. |
.\" such damage. |
.\" |
.\" |
.\" Id: elf_open.3 3181 2015-04-10 13:22:51Z emaste |
.\" Id: elf_open.3 3928 2021-03-07 19:47:55Z jkoshy |
.\" |
.\" |
.Dd May 31, 2012 |
.Dd June 12, 2019 |
.Os |
|
.Dt ELF_OPEN 3 |
.Dt ELF_OPEN 3 |
|
.Os |
.Sh NAME |
.Sh NAME |
.Nm elf_open |
.Nm elf_open |
.Nd open ELF objects and ar(1) archives |
.Nd open ELF objects and ar(1) archives |
|
|
.Fn elf_open |
.Fn elf_open |
and |
and |
.Fn elf_openmemory |
.Fn elf_openmemory |
are extensions to the ELF(3) API, for the internal use of the |
are extensions to the |
|
.Xr elf 3 |
|
API, for the internal use of the |
Elftoolchain project. |
Elftoolchain project. |
Portable applications should not use these functions. |
Portable applications should not use these functions. |
.Pp |
.Pp |
Line 69 archive contained in the memory area poi |
|
Line 71 archive contained in the memory area poi |
|
The argument |
The argument |
.Ar sz |
.Ar sz |
specifies the size of the memory area in bytes. |
specifies the size of the memory area in bytes. |
|
.Sh RETURN VALUES |
|
The function returns a pointer to a ELF descriptor if successful, or |
|
.Dv NULL |
|
if an error occurred. |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
These functions are non-standard extensions to the ELF(3) API set. |
These functions are non-standard extensions to the |
|
.Xr elf 3 |
|
API set. |
.Pp |
.Pp |
The behavior of these functions differs from their counterparts |
The behavior of these functions differs from their counterparts |
.Xr elf_begin 3 |
.Xr elf_begin 3 |
|
|
.Xr ar 1 |
.Xr ar 1 |
archives, returning an Elf descriptor of type |
archives, returning an Elf descriptor of type |
.Dv ELF_K_NONE . |
.Dv ELF_K_NONE . |
.Sh RETURN VALUES |
|
The function returns a pointer to a ELF descriptor if successful, or |
|
NULL if an error occurred. |
|
.Sh ERRORS |
.Sh ERRORS |
These functions can fail with the following errors: |
These functions can fail with the following errors: |
.Bl -tag -width "[ELF_E_RESOURCE]" |
.Bl -tag -width "[ELF_E_RESOURCE]" |
|
|
.Ar sz |
.Ar sz |
was zero, or the argument |
was zero, or the argument |
.Ar image |
.Ar image |
was NULL. |
was |
|
.Dv NULL . |
.It Bq Er ELF_E_IO |
.It Bq Er ELF_E_IO |
The file descriptor in argument |
The file descriptor in argument |
.Ar fd |
.Ar fd |