.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH GetIpForwardTable 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBGetIpForwardTable\fR (IPHLPAPI.@)
.SH SYNOPSIS
DWORD GetIpForwardTable
 (
  PMIB_IPFORWARDTABLE \fIpIpForwardTable\fR,
  PULONG              \fIpdwSize\fR,
  BOOL                \fIbOrder\fR
 )

.SH DESCRIPTION
.PP
Get the route table. 

.SH PARAMS
\fIpIpForwardTable\fR \fB[Out]\fR  buffer for route table.
.PP
\fIpdwSize\fR \fB[In/Out]\fR  length of output buffer.
.PP
\fIbOrder\fR \fB[In]\fR  whether to sort the table.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBNO_ERROR\fR 
.PP
\fBFailure:\fR error code from Winerror.h. 

.SH NOTES
.PP
If \fIpdwSize\fR is less than required, the function will return \fBERROR_INSUFFICIENT_BUFFER\fR, and *\fIpdwSize\fR will be set to the required byte size. If \fIbOrder\fR is \fBTRUE\fR, the returned table will be sorted by the next hop and an assortment of arbitrary parameters. 

.SH IMPLEMENTATION
.PP
Declared in \fB"ipstats.h"\fR. 
.PP
Implemented in \fB"dlls/iphlpapi/iphlpapi_main.c"\fR. 
.PP
Debug channel \fB"iphlpapi"\fR.