ホーム › NetworkManagement.IpHelper › ConvertIpv4MaskToLength

ConvertIpv4MaskToLength

関数

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

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

シグネチャ

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

WIN32_ERROR ConvertIpv4MaskToLength(
    DWORD Mask,
    BYTE* MaskLength
);

パラメーター

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

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

成功した場合、 ConvertIpv4MaskToLength は NO_ERROR を返します。0 以外の戻り値はすべて失敗を示します。

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

解説(Remarks)

ConvertIpv4MaskToLength 関数は、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 ConvertIpv4MaskToLength(
    DWORD Mask,
    BYTE* MaskLength
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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