ホーム › NetworkManagement.IpHelper › ConvertLengthToIpv4Mask

ConvertLengthToIpv4Mask

関数

プレフィックス長からIPv4サブネットマスクへ変換する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR ConvertLengthToIpv4Mask(
    DWORD MaskLength,
    DWORD* Mask
);

パラメーター

名前	型	方向	説明
MaskLength	DWORD	in	IPv4 プレフィックス長(ビット単位)。
Mask	DWORD*	out	関数が正常に終了したときに IPv4 サブネットマスクを格納する LONG 値へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

IPv4 プレフィックス長を IPv4 サブネットマスクに変換します。

戻り値

成功した場合、 ConvertLengthToIpv4Mask は NO_ERROR を返します。0 以外の戻り値は失敗を示し、Mask パラメーターは Ws2def.h ヘッダーファイルで定義されている INADDR_NONE に設定されます。

エラーコード	意味
ERROR_INVALID_PARAMETER	パラメーターのいずれかが無効でした。このエラーは MaskLength パラメーターが無効な場合に返されます。

解説(Remarks)

ConvertLengthToIpv4Mask 関数は Windows Vista 以降で使用できます。

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

各言語での呼び出し定義

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

WIN32_ERROR ConvertLengthToIpv4Mask(
    DWORD MaskLength,
    DWORD* Mask
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint ConvertLengthToIpv4Mask(
    uint MaskLength,   // DWORD
    out uint Mask   // DWORD* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function ConvertLengthToIpv4Mask(
    MaskLength As UInteger,   ' DWORD
    <Out> ByRef Mask As UInteger   ' DWORD* out
) As UInteger
End Function

' MaskLength : DWORD
' Mask : DWORD* out
Declare PtrSafe Function ConvertLengthToIpv4Mask Lib "iphlpapi" ( _
    ByVal MaskLength As Long, _
    ByRef Mask As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ConvertLengthToIpv4Mask = ctypes.windll.iphlpapi.ConvertLengthToIpv4Mask
ConvertLengthToIpv4Mask.restype = wintypes.DWORD
ConvertLengthToIpv4Mask.argtypes = [
    wintypes.DWORD,  # MaskLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # Mask : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
ConvertLengthToIpv4Mask = Fiddle::Function.new(
  lib['ConvertLengthToIpv4Mask'],
  [
    -Fiddle::TYPE_INT,  # MaskLength : DWORD
    Fiddle::TYPE_VOIDP,  # Mask : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn ConvertLengthToIpv4Mask(
        MaskLength: u32,  // DWORD
        Mask: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint ConvertLengthToIpv4Mask(uint MaskLength, out uint Mask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_ConvertLengthToIpv4Mask' -Namespace Win32 -PassThru
# $api::ConvertLengthToIpv4Mask(MaskLength, Mask)

#uselib "IPHLPAPI.dll"
#func global ConvertLengthToIpv4Mask "ConvertLengthToIpv4Mask" sptr, sptr
; ConvertLengthToIpv4Mask MaskLength, varptr(Mask)   ; 戻り値は stat
; MaskLength : DWORD -> "sptr"
; Mask : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global ConvertLengthToIpv4Mask "ConvertLengthToIpv4Mask" int, var
; res = ConvertLengthToIpv4Mask(MaskLength, Mask)
; MaskLength : DWORD -> "int"
; Mask : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global ConvertLengthToIpv4Mask "ConvertLengthToIpv4Mask" int, sptr
; res = ConvertLengthToIpv4Mask(MaskLength, varptr(Mask))
; MaskLength : DWORD -> "int"
; Mask : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。