mirror of
https://github.com/nodejs/node.git
synced 2025-08-15 13:48:44 +02:00
41d90aaf62
PR-URL: https://github.com/nodejs/node/pull/53155 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
65 lines
1.5 KiB
Groff
65 lines
1.5 KiB
Groff
.\"
|
|
.\" Copyright 1998 by the Massachusetts Institute of Technology.
|
|
.\" SPDX-License-Identifier: MIT
|
|
.\"
|
|
.TH ARES_PARSE_MX_REPLY 3 "4 August 2009"
|
|
.SH NAME
|
|
ares_parse_mx_reply \- Parse a reply to a DNS query of type MX
|
|
.SH SYNOPSIS
|
|
#include <ares.h>
|
|
|
|
int ares_parse_mx_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
|
|
struct ares_mx_reply** \fImx_out\fP);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
The
|
|
.B ares_parse_mx_reply
|
|
function parses the response to a query of type MX into a
|
|
linked list of
|
|
.I struct ares_mx_reply
|
|
The parameters
|
|
.I abuf
|
|
and
|
|
.I alen
|
|
give the contents of the response. The result is stored in allocated
|
|
memory and a pointer to it stored into the variable pointed to by
|
|
.IR mx_out .
|
|
It is the caller's responsibility to free the resulting
|
|
.IR mx_out
|
|
structure when it is no longer needed using the function
|
|
\fBares_free_data(3)\fP.
|
|
.PP
|
|
The structure
|
|
.I ares_mx_reply
|
|
contains the following fields:
|
|
.sp
|
|
.in +4n
|
|
.nf
|
|
struct ares_mx_reply {
|
|
struct ares_mx_reply *next;
|
|
char *host;
|
|
unsigned short priority;
|
|
};
|
|
.fi
|
|
.in
|
|
.PP
|
|
.SH RETURN VALUES
|
|
.B ares_parse_mx_reply
|
|
can return any of the following values:
|
|
.TP 15
|
|
.B ARES_SUCCESS
|
|
The response was successfully parsed.
|
|
.TP 15
|
|
.B ARES_EBADRESP
|
|
The response was malformatted.
|
|
.TP 15
|
|
.B ARES_ENODATA
|
|
The response did not contain an answer to the query.
|
|
.TP 15
|
|
.B ARES_ENOMEM
|
|
Memory was exhausted.
|
|
.SH AVAILABILITY
|
|
This function was first introduced in c-ares version 1.7.2.
|
|
.SH SEE ALSO
|
|
.BR ares_query (3)
|
|
.BR ares_free_data (3)
|