freeaddrinfo

関数

getaddrinfoが確保したアドレス情報を解放する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll
#include <windows.h>

void freeaddrinfo(
    ADDRINFOA* pAddrInfo   // optional
);

パラメーター

名前	型	方向	説明
pAddrInfo	ADDRINFOA*	inoptional	解放する addrinfo 構造体、または addrinfo 構造体のリンクリストへのポインターです。 addrinfo 構造体内のポインターが指すすべての動的記憶域も解放されます。

戻り値の型: void

公式ドキュメント

getaddrinfo 関数が addrinfo 構造体内に動的に割り当てたアドレス情報を解放します。

戻り値

この関数は値を返しません。

解説(Remarks)

freeaddrinfo 関数は、ANSI 版の getaddrinfo 関数によって動的に割り当てられた addrinfo 構造体を解放します。freeaddrinfo 関数は、ai パラメーターが指す最初の addrinfo 構造体を、その構造体メンバーが指すすべてのバッファーを含めて解放した後、その addrinfo 構造体の ai_next メンバーによってリンクされた addrinfo 構造体を引き続き解放します。 freeaddrinfo 関数は、ai_next メンバーが NULL になるまで、リンクされた構造体の解放を続けます。

Winsock ヘッダーファイル内のマクロは、大文字小文字を混在させた関数名 FreeAddrInfo と ADDRINFOT 構造体を定義しています。この FreeAddrInfo 関数は、ADDRINFOT 型のポインターを ai パラメーターに指定して呼び出してください。UNICODE または _UNICODE が定義されていない場合、FreeAddrInfo は ANSI 版の freeaddrinfo として定義され、ADDRINFOT は addrinfo 構造体として定義されます。UNICODE または _UNICODE が定義されている場合、FreeAddrInfo は Unicode 版の FreeAddrInfoW として定義され、ADDRINFOT は addrinfoW 構造体として定義されます。

以前のバージョンの Windows での freeaddrinfo のサポート

freeaddrinfo 関数は、Windows XP 以降の Ws2_32.dll に追加されました。

FreeAddrInfoW 関数は、freeaddrinfo の Unicode 版です。FreeAddrInfoW 関数は、Windows XP Service Pack 2 (SP2) の Ws2_32.dll に追加されました。FreeAddrInfoW 関数は、Windows XP with SP2 より前のバージョンの Windows では使用できません。

Windows Phone 8: freeaddrinfo 関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。

Windows 8.1 および Windows Server 2012 R2: freeaddrinfo 関数および FreeAddrInfoW 関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll
#include <windows.h>

void freeaddrinfo(
    ADDRINFOA* pAddrInfo   // optional
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern void freeaddrinfo(
    IntPtr pAddrInfo   // ADDRINFOA* optional
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Sub freeaddrinfo(
    pAddrInfo As IntPtr   ' ADDRINFOA* optional
)
End Sub

' pAddrInfo : ADDRINFOA* optional
Declare PtrSafe Sub freeaddrinfo Lib "ws2_32" ( _
    ByVal pAddrInfo As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

freeaddrinfo = ctypes.windll.ws2_32.freeaddrinfo
freeaddrinfo.restype = None
freeaddrinfo.argtypes = [
    ctypes.c_void_p,  # pAddrInfo : ADDRINFOA* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
freeaddrinfo = Fiddle::Function.new(
  lib['freeaddrinfo'],
  [
    Fiddle::TYPE_VOIDP,  # pAddrInfo : ADDRINFOA* optional
  ],
  Fiddle::TYPE_VOID)

#[link(name = "ws2_32")]
extern "system" {
    fn freeaddrinfo(
        pAddrInfo: *mut ADDRINFOA  // ADDRINFOA* optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern void freeaddrinfo(IntPtr pAddrInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_freeaddrinfo' -Namespace Win32 -PassThru
# $api::freeaddrinfo(pAddrInfo)

#uselib "WS2_32.dll"
#func global freeaddrinfo "freeaddrinfo" sptr
; freeaddrinfo varptr(pAddrInfo)
; pAddrInfo : ADDRINFOA* optional -> "sptr"

出力引数:

#uselib "WS2_32.dll"
#func global freeaddrinfo "freeaddrinfo" var
; freeaddrinfo pAddrInfo
; pAddrInfo : ADDRINFOA* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#func global freeaddrinfo "freeaddrinfo" sptr
; freeaddrinfo varptr(pAddrInfo)
; pAddrInfo : ADDRINFOA* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。