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

FreeAddrInfoW

関数
GetAddrInfoWが確保したアドレス情報を解放する。
DLLWS2_32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

void FreeAddrInfoW(
    ADDRINFOW* pAddrInfo   // optional
);

パラメーター

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

戻り値の型: void

公式ドキュメント

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

戻り値

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

解説(Remarks)

FreeAddrInfoW 関数は、Unicode 版の GetAddrInfoW 関数によって動的に割り当てられた addrinfoW 構造体を解放します。FreeAddrInfoW 関数は、pAddrInfo パラメーターで指定された最初の addrinfoW 構造体(構造体メンバーが指すすべてのバッファーを含む)を解放し、続いて addrinfoW 構造体の ai_next メンバーによって連結されている addrinfoW 構造体を解放していきます。 FreeAddrInfoW 関数は、ai_next メンバーが NULL になるまで連結された構造体を解放し続けます。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 FreeAddrInfoW(
    ADDRINFOW* pAddrInfo   // optional
);
[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern void FreeAddrInfoW(
    IntPtr pAddrInfo   // ADDRINFOW* optional
);
<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Sub FreeAddrInfoW(
    pAddrInfo As IntPtr   ' ADDRINFOW* optional
)
End Sub
' pAddrInfo : ADDRINFOW* optional
Declare PtrSafe Sub FreeAddrInfoW 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

FreeAddrInfoW = ctypes.windll.ws2_32.FreeAddrInfoW
FreeAddrInfoW.restype = None
FreeAddrInfoW.argtypes = [
    ctypes.c_void_p,  # pAddrInfo : ADDRINFOW* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procFreeAddrInfoW = ws2_32.NewProc("FreeAddrInfoW")
)

// pAddrInfo (ADDRINFOW* optional)
r1, _, err := procFreeAddrInfoW.Call(
	uintptr(pAddrInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure FreeAddrInfoW(
  pAddrInfo: Pointer   // ADDRINFOW* optional
); stdcall;
  external 'WS2_32.dll' name 'FreeAddrInfoW';
result := DllCall("WS2_32\FreeAddrInfoW"
    , "Ptr", pAddrInfo   ; ADDRINFOW* optional
    , "Int")   ; return: void
●FreeAddrInfoW(pAddrInfo) = DLL("WS2_32.dll", "int FreeAddrInfoW(void*)")
# 呼び出し: FreeAddrInfoW(pAddrInfo)
# pAddrInfo : ADDRINFOW* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn FreeAddrInfoW(
    pAddrInfo: [*c]ADDRINFOW // ADDRINFOW* optional
) callconv(std.os.windows.WINAPI) void;
proc FreeAddrInfoW(
    pAddrInfo: ptr ADDRINFOW  # ADDRINFOW* optional
) {.importc: "FreeAddrInfoW", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
void FreeAddrInfoW(
    ADDRINFOW* pAddrInfo   // ADDRINFOW* optional
);
ccall((:FreeAddrInfoW, "WS2_32.dll"), stdcall, Cvoid,
      (Ptr{ADDRINFOW},),
      pAddrInfo)
# pAddrInfo : ADDRINFOW* optional -> Ptr{ADDRINFOW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void FreeAddrInfoW(
    void* pAddrInfo);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.FreeAddrInfoW(pAddrInfo)
-- pAddrInfo : ADDRINFOW* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const FreeAddrInfoW = lib.func('__stdcall', 'FreeAddrInfoW', 'void', ['void *']);
// FreeAddrInfoW(pAddrInfo)
// pAddrInfo : ADDRINFOW* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  FreeAddrInfoW: { parameters: ["pointer"], result: "void" },
});
// lib.symbols.FreeAddrInfoW(pAddrInfo)
// pAddrInfo : ADDRINFOW* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void FreeAddrInfoW(
    void* pAddrInfo);
C, "WS2_32.dll");
// $ffi->FreeAddrInfoW(pAddrInfo);
// pAddrInfo : ADDRINFOW* 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);
    void FreeAddrInfoW(
        Pointer pAddrInfo   // ADDRINFOW* optional
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun FreeAddrInfoW = FreeAddrInfoW(
    pAddrInfo : ADDRINFOW*   # ADDRINFOW* optional
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let freeaddrinfow =
  foreign "FreeAddrInfoW"
    ((ptr void) @-> returning void)
(* pAddrInfo : ADDRINFOW* 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 ("FreeAddrInfoW" free-addr-info-w :convention :stdcall) :void
  (p-addr-info :pointer))   ; ADDRINFOW* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FreeAddrInfoW = Win32::API::More->new('WS2_32',
    'void FreeAddrInfoW(LPVOID pAddrInfo)');
# my $ret = $FreeAddrInfoW->Call($pAddrInfo);
# pAddrInfo : ADDRINFOW* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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