1.\" Copyright (c) 1998 John D. Polstra 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD: src/lib/libc/gen/getobjformat.3,v 1.3.2.6 2003/03/13 18:05:37 trhodes Exp $ 26.\" $DragonFly: src/lib/libc/gen/getobjformat.3,v 1.2 2003/06/17 04:26:42 dillon Exp $ 27.\" 28.Dd May 23, 2009 29.Dt GETOBJFORMAT 3 30.Os 31.Sh NAME 32.Nm getobjformat 33.Nd get preferred object file format 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In objformat.h 38.Ft int 39.Fn getobjformat "char *buf" "size_t bufsize" "int *argcp __unused" "char **argv __unused" 40.Sh DESCRIPTION 41The 42.Fn getobjformat 43function copies the name of the preferred object file format 44.Dq ( elf ) 45into a buffer provided by the caller. 46The function is currently provided only for backward compatibility. 47.Pp 48.Va buf 49points to a user-supplied buffer into which the name of the object 50file format is copied. 51.Va bufsize 52gives the size of the buffer in bytes. 53The string placed in 54.Va buf 55is always null-terminated. 56It is an error if the buffer is too small to hold the null-terminated name. 57.Pp 58.Va argv 59and 60.Va argcp 61are unused and new applications should set them to 62.Dv NULL . 63.Sh RETURN VALUES 64On success, 65.Fn getobjformat 66returns the length of the object file format name, not counting the 67null terminator. 68If the supplied buffer is too small to hold the object file format 69and its null terminator, 70.Fn getobjformat 71returns -1. 72In that case, the contents of the buffer and argument 73vector supplied by the caller are indeterminate. 74.Sh SEE ALSO 75.Xr objformat 1 76.Sh HISTORY 77The 78.Fn getobjformat 79function first appeared in 80.Fx 3.0 . 81