ホーム › NetworkManagement.NetManagement › NetApiBufferSize
NetApiBufferSize
関数ネットワークAPIが割り当てたバッファのサイズを取得する。
シグネチャ
// NETAPI32.dll
#include <windows.h>
DWORD NetApiBufferSize(
void* Buffer,
DWORD* ByteCount
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Buffer | void* | in | NetApiBufferAllocate 関数によって返されたバッファへのポインターです。 |
| ByteCount | DWORD* | out | バッファのサイズをバイト単位で受け取ります。 |
戻り値の型: DWORD
公式ドキュメント
NetApiBufferSize 関数は、NetApiBufferAllocate 関数の呼び出しによって割り当てられたバッファのサイズをバイト単位で返します。
戻り値
関数が成功した場合、戻り値は NERR_Success です。
関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの一覧については、 System Error Codes を参照してください。
解説(Remarks)
ApiBuffer 関数を正常に実行するために特別なグループメンバーシップは必要ありません。
ネットワーク管理の ApiBuffer functions の使用方法を示すコードサンプルについては、 NetApiBufferAllocate を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// NETAPI32.dll
#include <windows.h>
DWORD NetApiBufferSize(
void* Buffer,
DWORD* ByteCount
);[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetApiBufferSize(
IntPtr Buffer, // void*
out uint ByteCount // DWORD* out
);<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetApiBufferSize(
Buffer As IntPtr, ' void*
<Out> ByRef ByteCount As UInteger ' DWORD* out
) As UInteger
End Function' Buffer : void*
' ByteCount : DWORD* out
Declare PtrSafe Function NetApiBufferSize Lib "netapi32" ( _
ByVal Buffer As LongPtr, _
ByRef ByteCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
NetApiBufferSize = ctypes.windll.netapi32.NetApiBufferSize
NetApiBufferSize.restype = wintypes.DWORD
NetApiBufferSize.argtypes = [
ctypes.POINTER(None), # Buffer : void*
ctypes.POINTER(wintypes.DWORD), # ByteCount : DWORD* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('NETAPI32.dll')
NetApiBufferSize = Fiddle::Function.new(
lib['NetApiBufferSize'],
[
Fiddle::TYPE_VOIDP, # Buffer : void*
Fiddle::TYPE_VOIDP, # ByteCount : DWORD* out
],
-Fiddle::TYPE_INT)#[link(name = "netapi32")]
extern "system" {
fn NetApiBufferSize(
Buffer: *mut (), // void*
ByteCount: *mut u32 // DWORD* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetApiBufferSize(IntPtr Buffer, out uint ByteCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetApiBufferSize' -Namespace Win32 -PassThru
# $api::NetApiBufferSize(Buffer, ByteCount)#uselib "NETAPI32.dll"
#func global NetApiBufferSize "NetApiBufferSize" sptr, sptr
; NetApiBufferSize Buffer, varptr(ByteCount) ; 戻り値は stat
; Buffer : void* -> "sptr"
; ByteCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "NETAPI32.dll" #cfunc global NetApiBufferSize "NetApiBufferSize" sptr, var ; res = NetApiBufferSize(Buffer, ByteCount) ; Buffer : void* -> "sptr" ; ByteCount : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll" #cfunc global NetApiBufferSize "NetApiBufferSize" sptr, sptr ; res = NetApiBufferSize(Buffer, varptr(ByteCount)) ; Buffer : void* -> "sptr" ; ByteCount : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD NetApiBufferSize(void* Buffer, DWORD* ByteCount) #uselib "NETAPI32.dll" #cfunc global NetApiBufferSize "NetApiBufferSize" intptr, var ; res = NetApiBufferSize(Buffer, ByteCount) ; Buffer : void* -> "intptr" ; ByteCount : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD NetApiBufferSize(void* Buffer, DWORD* ByteCount) #uselib "NETAPI32.dll" #cfunc global NetApiBufferSize "NetApiBufferSize" intptr, intptr ; res = NetApiBufferSize(Buffer, varptr(ByteCount)) ; Buffer : void* -> "intptr" ; ByteCount : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
procNetApiBufferSize = netapi32.NewProc("NetApiBufferSize")
)
// Buffer (void*), ByteCount (DWORD* out)
r1, _, err := procNetApiBufferSize.Call(
uintptr(Buffer),
uintptr(ByteCount),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction NetApiBufferSize(
Buffer: Pointer; // void*
ByteCount: Pointer // DWORD* out
): DWORD; stdcall;
external 'NETAPI32.dll' name 'NetApiBufferSize';result := DllCall("NETAPI32\NetApiBufferSize"
, "Ptr", Buffer ; void*
, "Ptr", ByteCount ; DWORD* out
, "UInt") ; return: DWORD●NetApiBufferSize(Buffer, ByteCount) = DLL("NETAPI32.dll", "dword NetApiBufferSize(void*, void*)")
# 呼び出し: NetApiBufferSize(Buffer, ByteCount)
# Buffer : void* -> "void*"
# ByteCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "netapi32" fn NetApiBufferSize(
Buffer: ?*anyopaque, // void*
ByteCount: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;proc NetApiBufferSize(
Buffer: pointer, # void*
ByteCount: ptr uint32 # DWORD* out
): uint32 {.importc: "NetApiBufferSize", stdcall, dynlib: "NETAPI32.dll".}pragma(lib, "netapi32");
extern(Windows)
uint NetApiBufferSize(
void* Buffer, // void*
uint* ByteCount // DWORD* out
);ccall((:NetApiBufferSize, "NETAPI32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{UInt32}),
Buffer, ByteCount)
# Buffer : void* -> Ptr{Cvoid}
# ByteCount : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t NetApiBufferSize(
void* Buffer,
uint32_t* ByteCount);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetApiBufferSize(Buffer, ByteCount)
-- Buffer : void*
-- ByteCount : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetApiBufferSize = lib.func('__stdcall', 'NetApiBufferSize', 'uint32_t', ['void *', 'uint32_t *']);
// NetApiBufferSize(Buffer, ByteCount)
// Buffer : void* -> 'void *'
// ByteCount : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("NETAPI32.dll", {
NetApiBufferSize: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetApiBufferSize(Buffer, ByteCount)
// Buffer : void* -> "pointer"
// ByteCount : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t NetApiBufferSize(
void* Buffer,
uint32_t* ByteCount);
C, "NETAPI32.dll");
// $ffi->NetApiBufferSize(Buffer, ByteCount);
// Buffer : void*
// ByteCount : DWORD* out
// 構造体/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 Netapi32 extends StdCallLibrary {
Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
int NetApiBufferSize(
Pointer Buffer, // void*
IntByReference ByteCount // DWORD* out
);
}@[Link("netapi32")]
lib LibNETAPI32
fun NetApiBufferSize = NetApiBufferSize(
Buffer : Void*, # void*
ByteCount : UInt32* # DWORD* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef NetApiBufferSizeNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef NetApiBufferSizeDart = int Function(Pointer<Void>, Pointer<Uint32>);
final NetApiBufferSize = DynamicLibrary.open('NETAPI32.dll')
.lookupFunction<NetApiBufferSizeNative, NetApiBufferSizeDart>('NetApiBufferSize');
// Buffer : void* -> Pointer<Void>
// ByteCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function NetApiBufferSize(
Buffer: Pointer; // void*
ByteCount: Pointer // DWORD* out
): DWORD; stdcall;
external 'NETAPI32.dll' name 'NetApiBufferSize';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NetApiBufferSize"
c_NetApiBufferSize :: Ptr () -> Ptr Word32 -> IO Word32
-- Buffer : void* -> Ptr ()
-- ByteCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let netapibuffersize =
foreign "NetApiBufferSize"
((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* Buffer : void* -> (ptr void) *)
(* ByteCount : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)
(cffi:defcfun ("NetApiBufferSize" net-api-buffer-size :convention :stdcall) :uint32
(buffer :pointer) ; void*
(byte-count :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NetApiBufferSize = Win32::API::More->new('NETAPI32',
'DWORD NetApiBufferSize(LPVOID Buffer, LPVOID ByteCount)');
# my $ret = $NetApiBufferSize->Call($Buffer, $ByteCount);
# Buffer : void* -> LPVOID
# ByteCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f NetApiBufferAllocate — ネットワークAPI関数用のメモリバッファを割り当てる。
- f NetApiBufferFree — ネットワークAPIが割り当てたメモリバッファを解放する。