'\" te
.\" Copyright (C) 2008, Sun Microsystems, Inc. All Rights Reserved.
.TH net_getlifaddr 9F "13 Oct 2008" "SunOS 5.11" "Kernel Functions for Drivers"
.SH NAME
net_getlifaddr \- determine a network address for a given interface
.SH SYNOPSIS
.LP
.nf
#include <sys/neti.h>

\fBint\fR \fBnet_getlifaddr\fR(\fBconst\fR \fBnet_data_t\fR \fInet\fR, \fBconst\fR \fBphy_if_t\fR \fIifp\fR, 
     \fBconst\fR \fBnet_if_t\fR \fIlif\fR, \fBint\fR \fBconst\fR \fItype\fR, 
     \fBstruct\fR \fBsockaddr*\fR \fIstorage\fR);
.fi

.SH INTERFACE LEVEL
.sp
.LP
Solaris DDI specific (Solaris DDI).
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fInet\fR\fR
.ad
.RS 11n
.rt  
value returned from a successful call to \fBnet_protocol_lookup\fR(9F).
.RE

.sp
.ne 2
.mk
.na
\fB\fIifp\fR\fR
.ad
.RS 11n
.rt  
value returned from a successful call to \fBnet_phylookup\fR(9F) or \fBnet_phygetnext\fR(9F), indicating which network interface the information should be returned from.
.RE

.sp
.ne 2
.mk
.na
\fB\fIlif\fR\fR
.ad
.RS 11n
.rt  
indicates the logical interface from which to fetch the address.
.RE

.sp
.ne 2
.mk
.na
\fB\fItype\fR\fR
.ad
.RS 11n
.rt  
indicates what type of address should be returned. See below for more details on this field.
.RE

.sp
.ne 2
.mk
.na
\fB\fIstorage\fR\fR
.ad
.RS 11n
.rt  
pointer to an area of memory to store the address data.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBnet_getlifaddr()\fR function retrieves the address information for each logical interface. Each call to \fBnet_getlifaddr()\fR requires that the caller pass a pointer to an array of address information types to retrieve, and an accompanying pointer to an array of pointers to \fBstruct sockaddr\fR structures to which to copy the address information. See \fBnet_lifgetnext\fR(9F) for an example on how to use this function.
.sp
.LP
Each member of the address \fBtype\fR array should be one of the values listed here.
.sp
.ne 2
.mk
.na
\fB\fBNA_ADDRESS\fR\fR
.ad
.RS 16n
.rt  
Return the network address associated with the logical interface (\fBlif\fR) that belongs to the network interface (\fBifp\fR).
.RE

.sp
.ne 2
.mk
.na
\fB\fBNA_PEER\fR\fR
.ad
.RS 16n
.rt  
Return the address assigned to the remote host for point to point network interfaces for the given network/logical interface.
.RE

.sp
.ne 2
.mk
.na
\fB\fBNA_BROADCAST\fR\fR
.ad
.RS 16n
.rt  
Return the broadcast address assigned to the given network/logical interface for network interfaces that support broadcast packets.
.RE

.sp
.ne 2
.mk
.na
\fB\fBNA_NETMASK\fR\fR
.ad
.RS 16n
.rt  
Return the netmask associated with the given network/logical interface for network interfaces that support broadcast packets. 
.RE

.SH RETURN VALUES
.sp
.LP
The \fBnet_getlifaddr()\fR function returns:
.sp
.ne 2
.mk
.na
\fB-1\fR
.ad
.RS 6n
.rt  
The network protocol does not support this function.
.RE

.sp
.ne 2
.mk
.na
\fB0\fR
.ad
.RS 6n
.rt  
Successful completion.
.RE

.sp
.ne 2
.mk
.na
\fB1\fR
.ad
.RS 6n
.rt  
Unsuccessful.
.RE

.SH CONTEXT
.sp
.LP
The \fBnet_getifaddr()\fR function may be called from user, kernel, or interrupt context. 
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/core-os
_
Interface StabilityCommitted
.TE

.SH SEE ALSO
.sp
.LP
\fBnet_lifgetnext\fR(9F), \fBnet_phylookup\fR(9F), \fBnet_phygetnext\fR(9F)\fBnet_protocol_lookup\fR(9F)