share/man/man3dlpi/dlpi_linkname.3dlpi

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DLPI_LINKNAME 3DLPI "Jun 15, 2007"
   7 .SH NAME
   8 dlpi_linkname \- get DLPI link name
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ldlpi\fR [ \fIlibrary\fR ... ]
  13 #include <libdlpi.h>
  14
  15 \fBconst char *\fR\fIdlpi_linkname\fR(\fBdlpi_handle_t\fR \fIdh\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBdlpi_linkname()\fR function returns a pointer to the link name of the
  22 \fBDLPI\fR link instance associated with the \fBDLPI\fR handle \fIdh\fR.
  23 .sp
  24 .LP
  25 The returned string is managed by \fBlibdlpi\fR and must not be modified or
  26 freed by the caller.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 Upon success, the function returns a pointer to the link name associated with
  31 the \fBDLPI\fR handle.
  32 .SH ATTRIBUTES
  33 .sp
  34 .LP
  35 See \fBattributes\fR(5) for description of the following attributes:
  36 .sp
  37
  38 .sp
  39 .TS
  40 box;
  41 c | c
  42 l | l .
  43 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  44 _
  45 Interface Stability     Committed
  46 _
  47 MT-Level        Safe
  48 .TE
  49
  50 .SH SEE ALSO
  51 .sp
  52 .LP
  53 \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)