Win32 API 日本語リファレンス
ホームNetworking.WinSock › FreeAddrInfoExW

FreeAddrInfoExW

関数
拡張アドレス情報構造体のメモリを解放する。
DLLWS2_32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

// WS2_32.dll  (Unicode / -W)
#include <windows.h>

void FreeAddrInfoExW(
    ADDRINFOEXW* pAddrInfoEx   // optional
);

パラメーター

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

戻り値の型: void

公式ドキュメント

FreeAddrInfoExW (Unicode) 関数 (ws2tcpip.h) は、GetAddrInfoEx 関数が addrinfoex 構造体内に動的に割り当てたアドレス情報を解放します。

戻り値

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

解説(Remarks)

FreeAddrInfoEx 関数は、GetAddrInfoEx 関数によって動的に割り当てられた addrinfoex 構造体を解放します。FreeAddrInfoEx 関数は、pAddrInfo パラメーターが指す最初の addrinfoex 構造体を、その構造体メンバーが指す任意のバッファーを含めて解放し、続けて addrinfoex 構造体の ai_next メンバーによって連結された addrinfoex 構造体を解放していきます。 FreeAddrInfoEx 関数は、ai_next メンバーが NULL になるまで、連結された構造体の解放を続けます。

UNICODE または _UNICODE が定義されている場合、FreeAddrInfoEx は関数の Unicode 版である FreeAddrInfoExW として定義され、ADDRINFOEXaddrinfoexW 構造体として定義されます。UNICODE または _UNICODE が定義されていない場合、FreeAddrInfoEx は関数の ANSI 版である FreeAddrInfoExA として定義され、ADDRINFOEXaddrinfoexA 構造体として定義されます。

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

メモ

ws2tcpip.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FreeAddrInfoEx を定義します。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約 を参照してください。

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

各言語での呼び出し定義

// WS2_32.dll  (Unicode / -W)
#include <windows.h>

void FreeAddrInfoExW(
    ADDRINFOEXW* pAddrInfoEx   // optional
);
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void FreeAddrInfoExW(
    IntPtr pAddrInfoEx   // ADDRINFOEXW* optional
);
<DllImport("WS2_32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub FreeAddrInfoExW(
    pAddrInfoEx As IntPtr   ' ADDRINFOEXW* optional
)
End Sub
' pAddrInfoEx : ADDRINFOEXW* optional
Declare PtrSafe Sub FreeAddrInfoExW Lib "ws2_32" ( _
    ByVal pAddrInfoEx As LongPtr)
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FreeAddrInfoExW = ctypes.windll.ws2_32.FreeAddrInfoExW
FreeAddrInfoExW.restype = None
FreeAddrInfoExW.argtypes = [
    ctypes.c_void_p,  # pAddrInfoEx : ADDRINFOEXW* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
FreeAddrInfoExW = Fiddle::Function.new(
  lib['FreeAddrInfoExW'],
  [
    Fiddle::TYPE_VOIDP,  # pAddrInfoEx : ADDRINFOEXW* optional
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "ws2_32")]
extern "system" {
    fn FreeAddrInfoExW(
        pAddrInfoEx: *mut ADDRINFOEXW  // ADDRINFOEXW* optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WS2_32.dll", CharSet = CharSet.Unicode)]
public static extern void FreeAddrInfoExW(IntPtr pAddrInfoEx);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_FreeAddrInfoExW' -Namespace Win32 -PassThru
# $api::FreeAddrInfoExW(pAddrInfoEx)
#uselib "WS2_32.dll"
#func global FreeAddrInfoExW "FreeAddrInfoExW" wptr
; FreeAddrInfoExW varptr(pAddrInfoEx)
; pAddrInfoEx : ADDRINFOEXW* optional -> "wptr"
出力引数:
#uselib "WS2_32.dll"
#func global FreeAddrInfoExW "FreeAddrInfoExW" var
; FreeAddrInfoExW pAddrInfoEx
; pAddrInfoEx : ADDRINFOEXW* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void FreeAddrInfoExW(ADDRINFOEXW* pAddrInfoEx)
#uselib "WS2_32.dll"
#func global FreeAddrInfoExW "FreeAddrInfoExW" var
; FreeAddrInfoExW pAddrInfoEx
; pAddrInfoEx : ADDRINFOEXW* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procFreeAddrInfoExW = ws2_32.NewProc("FreeAddrInfoExW")
)

// pAddrInfoEx (ADDRINFOEXW* optional)
r1, _, err := procFreeAddrInfoExW.Call(
	uintptr(pAddrInfoEx),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure FreeAddrInfoExW(
  pAddrInfoEx: Pointer   // ADDRINFOEXW* optional
); stdcall;
  external 'WS2_32.dll' name 'FreeAddrInfoExW';
result := DllCall("WS2_32\FreeAddrInfoExW"
    , "Ptr", pAddrInfoEx   ; ADDRINFOEXW* optional
    , "Int")   ; return: void
●FreeAddrInfoExW(pAddrInfoEx) = DLL("WS2_32.dll", "int FreeAddrInfoExW(void*)")
# 呼び出し: FreeAddrInfoExW(pAddrInfoEx)
# pAddrInfoEx : ADDRINFOEXW* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ws2_32" fn FreeAddrInfoExW(
    pAddrInfoEx: [*c]ADDRINFOEXW // ADDRINFOEXW* optional
) callconv(std.os.windows.WINAPI) void;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FreeAddrInfoExW(
    pAddrInfoEx: ptr ADDRINFOEXW  # ADDRINFOEXW* optional
) {.importc: "FreeAddrInfoExW", stdcall, dynlib: "WS2_32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ws2_32");
extern(Windows)
void FreeAddrInfoExW(
    ADDRINFOEXW* pAddrInfoEx   // ADDRINFOEXW* optional
);
ccall((:FreeAddrInfoExW, "WS2_32.dll"), stdcall, Cvoid,
      (Ptr{ADDRINFOEXW},),
      pAddrInfoEx)
# pAddrInfoEx : ADDRINFOEXW* optional -> Ptr{ADDRINFOEXW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void FreeAddrInfoExW(
    void* pAddrInfoEx);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.FreeAddrInfoExW(pAddrInfoEx)
-- pAddrInfoEx : ADDRINFOEXW* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const FreeAddrInfoExW = lib.func('__stdcall', 'FreeAddrInfoExW', 'void', ['void *']);
// FreeAddrInfoExW(pAddrInfoEx)
// pAddrInfoEx : ADDRINFOEXW* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  FreeAddrInfoExW: { parameters: ["pointer"], result: "void" },
});
// lib.symbols.FreeAddrInfoExW(pAddrInfoEx)
// pAddrInfoEx : ADDRINFOEXW* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void FreeAddrInfoExW(
    void* pAddrInfoEx);
C, "WS2_32.dll");
// $ffi->FreeAddrInfoExW(pAddrInfoEx);
// pAddrInfoEx : ADDRINFOEXW* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class, W32APIOptions.UNICODE_OPTIONS);
    void FreeAddrInfoExW(
        Pointer pAddrInfoEx   // ADDRINFOEXW* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ws2_32")]
lib LibWS2_32
  fun FreeAddrInfoExW = FreeAddrInfoExW(
    pAddrInfoEx : ADDRINFOEXW*   # ADDRINFOEXW* optional
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FreeAddrInfoExWNative = Void Function(Pointer<Void>);
typedef FreeAddrInfoExWDart = void Function(Pointer<Void>);
final FreeAddrInfoExW = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<FreeAddrInfoExWNative, FreeAddrInfoExWDart>('FreeAddrInfoExW');
// pAddrInfoEx : ADDRINFOEXW* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure FreeAddrInfoExW(
  pAddrInfoEx: Pointer   // ADDRINFOEXW* optional
); stdcall;
  external 'WS2_32.dll' name 'FreeAddrInfoExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FreeAddrInfoExW"
  c_FreeAddrInfoExW :: Ptr () -> IO ()
-- pAddrInfoEx : ADDRINFOEXW* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let freeaddrinfoexw =
  foreign "FreeAddrInfoExW"
    ((ptr void) @-> returning void)
(* pAddrInfoEx : ADDRINFOEXW* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("FreeAddrInfoExW" free-addr-info-ex-w :convention :stdcall) :void
  (p-addr-info-ex :pointer))   ; ADDRINFOEXW* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FreeAddrInfoExW = Win32::API::More->new('WS2_32',
    'void FreeAddrInfoExW(LPVOID pAddrInfoEx)');
# my $ret = $FreeAddrInfoExW->Call($pAddrInfoEx);
# pAddrInfoEx : ADDRINFOEXW* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

公式の関連項目
使用する型