186d7f5d3SJohn Marino.\" Copyright (c) 1998 John D. Polstra 286d7f5d3SJohn Marino.\" All rights reserved. 386d7f5d3SJohn Marino.\" 486d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without 586d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions 686d7f5d3SJohn Marino.\" are met: 786d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright 886d7f5d3SJohn Marino.\" notice, this list of conditions and the following disclaimer. 986d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright 1086d7f5d3SJohn Marino.\" notice, this list of conditions and the following disclaimer in the 1186d7f5d3SJohn Marino.\" documentation and/or other materials provided with the distribution. 1286d7f5d3SJohn Marino.\" 1386d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1486d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1586d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1686d7f5d3SJohn Marino.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1786d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1886d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 1986d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2086d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2186d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2286d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2386d7f5d3SJohn Marino.\" SUCH DAMAGE. 2486d7f5d3SJohn Marino.\" 2586d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/gen/getobjformat.3,v 1.3.2.6 2003/03/13 18:05:37 trhodes Exp $ 2686d7f5d3SJohn Marino.\" $DragonFly: src/lib/libc/gen/getobjformat.3,v 1.2 2003/06/17 04:26:42 dillon Exp $ 2786d7f5d3SJohn Marino.\" 2886d7f5d3SJohn Marino.Dd May 23, 2009 2986d7f5d3SJohn Marino.Dt GETOBJFORMAT 3 3086d7f5d3SJohn Marino.Os 3186d7f5d3SJohn Marino.Sh NAME 3286d7f5d3SJohn Marino.Nm getobjformat 3386d7f5d3SJohn Marino.Nd get preferred object file format 3486d7f5d3SJohn Marino.Sh LIBRARY 3586d7f5d3SJohn Marino.Lb libc 3686d7f5d3SJohn Marino.Sh SYNOPSIS 3786d7f5d3SJohn Marino.In objformat.h 3886d7f5d3SJohn Marino.Ft int 3986d7f5d3SJohn Marino.Fn getobjformat "char *buf" "size_t bufsize" "int *argcp __unused" "char **argv __unused" 4086d7f5d3SJohn Marino.Sh DESCRIPTION 4186d7f5d3SJohn MarinoThe 4286d7f5d3SJohn Marino.Fn getobjformat 4386d7f5d3SJohn Marinofunction copies the name of the preferred object file format 4486d7f5d3SJohn Marino.Dq ( elf ) 4586d7f5d3SJohn Marinointo a buffer provided by the caller. 4686d7f5d3SJohn MarinoThe function is currently provided only for backward compatibility. 4786d7f5d3SJohn Marino.Pp 4886d7f5d3SJohn Marino.Va buf 4986d7f5d3SJohn Marinopoints to a user-supplied buffer into which the name of the object 5086d7f5d3SJohn Marinofile format is copied. 5186d7f5d3SJohn Marino.Va bufsize 5286d7f5d3SJohn Marinogives the size of the buffer in bytes. 5386d7f5d3SJohn MarinoThe string placed in 5486d7f5d3SJohn Marino.Va buf 5586d7f5d3SJohn Marinois always null-terminated. 5686d7f5d3SJohn MarinoIt is an error if the buffer is too small to hold the null-terminated name. 5786d7f5d3SJohn Marino.Pp 5886d7f5d3SJohn Marino.Va argv 5986d7f5d3SJohn Marinoand 6086d7f5d3SJohn Marino.Va argcp 6186d7f5d3SJohn Marinoare unused and new applications should set them to 6286d7f5d3SJohn Marino.Dv NULL . 6386d7f5d3SJohn Marino.Sh RETURN VALUES 6486d7f5d3SJohn MarinoOn success, 6586d7f5d3SJohn Marino.Fn getobjformat 6686d7f5d3SJohn Marinoreturns the length of the object file format name, not counting the 6786d7f5d3SJohn Marinonull terminator. 6886d7f5d3SJohn MarinoIf the supplied buffer is too small to hold the object file format 6986d7f5d3SJohn Marinoand its null terminator, 7086d7f5d3SJohn Marino.Fn getobjformat 7186d7f5d3SJohn Marinoreturns -1. 7286d7f5d3SJohn MarinoIn that case, the contents of the buffer and argument 7386d7f5d3SJohn Marinovector supplied by the caller are indeterminate. 7486d7f5d3SJohn Marino.Sh SEE ALSO 7586d7f5d3SJohn Marino.Xr objformat 1 7686d7f5d3SJohn Marino.Sh HISTORY 7786d7f5d3SJohn MarinoThe 7886d7f5d3SJohn Marino.Fn getobjformat 7986d7f5d3SJohn Marinofunction first appeared in 8086d7f5d3SJohn Marino.Fx 3.0 . 81