Win32 API 日本語リファレンス
ホームNetworkManagement.P2P › PeerDistClientBlockRead

PeerDistClientBlockRead

関数
クライアントのコンテンツからブロック単位で読み取る。
DLLPeerDist.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

DWORD PeerDistClientBlockRead(
    INT_PTR hPeerDist,
    INT_PTR hContentHandle,
    DWORD cbMaxNumberOfBytes,
    BYTE* pBuffer,   // optional
    DWORD dwTimeoutInMilliseconds,
    OVERLAPPED* lpOverlapped
);

パラメーター

名前方向説明
hPeerDistINT_PTRin対象のPeerDistセッションのハンドル。
hContentHandleINT_PTRin読み取り対象のコンテンツハンドル。
cbMaxNumberOfBytesDWORDinpBufferが受け取れる最大バイト数。
pBufferBYTE*outoptional読み取ったブロックデータを格納する出力バッファへのポインタ。
dwTimeoutInMillisecondsDWORDin読み取りのタイムアウト時間(ミリ秒)。
lpOverlappedOVERLAPPED*in非同期操作に使用するOVERLAPPED構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PeerDistClientBlockRead(
    INT_PTR hPeerDist,
    INT_PTR hContentHandle,
    DWORD cbMaxNumberOfBytes,
    BYTE* pBuffer,   // optional
    DWORD dwTimeoutInMilliseconds,
    OVERLAPPED* lpOverlapped
);
[DllImport("PeerDist.dll", ExactSpelling = true)]
static extern uint PeerDistClientBlockRead(
    IntPtr hPeerDist,   // INT_PTR
    IntPtr hContentHandle,   // INT_PTR
    uint cbMaxNumberOfBytes,   // DWORD
    IntPtr pBuffer,   // BYTE* optional, out
    uint dwTimeoutInMilliseconds,   // DWORD
    IntPtr lpOverlapped   // OVERLAPPED*
);
<DllImport("PeerDist.dll", ExactSpelling:=True)>
Public Shared Function PeerDistClientBlockRead(
    hPeerDist As IntPtr,   ' INT_PTR
    hContentHandle As IntPtr,   ' INT_PTR
    cbMaxNumberOfBytes As UInteger,   ' DWORD
    pBuffer As IntPtr,   ' BYTE* optional, out
    dwTimeoutInMilliseconds As UInteger,   ' DWORD
    lpOverlapped As IntPtr   ' OVERLAPPED*
) As UInteger
End Function
' hPeerDist : INT_PTR
' hContentHandle : INT_PTR
' cbMaxNumberOfBytes : DWORD
' pBuffer : BYTE* optional, out
' dwTimeoutInMilliseconds : DWORD
' lpOverlapped : OVERLAPPED*
Declare PtrSafe Function PeerDistClientBlockRead Lib "peerdist" ( _
    ByVal hPeerDist As LongPtr, _
    ByVal hContentHandle As LongPtr, _
    ByVal cbMaxNumberOfBytes As Long, _
    ByVal pBuffer As LongPtr, _
    ByVal dwTimeoutInMilliseconds As Long, _
    ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PeerDistClientBlockRead = ctypes.windll.peerdist.PeerDistClientBlockRead
PeerDistClientBlockRead.restype = wintypes.DWORD
PeerDistClientBlockRead.argtypes = [
    ctypes.c_ssize_t,  # hPeerDist : INT_PTR
    ctypes.c_ssize_t,  # hContentHandle : INT_PTR
    wintypes.DWORD,  # cbMaxNumberOfBytes : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pBuffer : BYTE* optional, out
    wintypes.DWORD,  # dwTimeoutInMilliseconds : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PeerDist.dll')
PeerDistClientBlockRead = Fiddle::Function.new(
  lib['PeerDistClientBlockRead'],
  [
    Fiddle::TYPE_INTPTR_T,  # hPeerDist : INT_PTR
    Fiddle::TYPE_INTPTR_T,  # hContentHandle : INT_PTR
    -Fiddle::TYPE_INT,  # cbMaxNumberOfBytes : DWORD
    Fiddle::TYPE_VOIDP,  # pBuffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # dwTimeoutInMilliseconds : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "peerdist")]
extern "system" {
    fn PeerDistClientBlockRead(
        hPeerDist: isize,  // INT_PTR
        hContentHandle: isize,  // INT_PTR
        cbMaxNumberOfBytes: u32,  // DWORD
        pBuffer: *mut u8,  // BYTE* optional, out
        dwTimeoutInMilliseconds: u32,  // DWORD
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("PeerDist.dll")]
public static extern uint PeerDistClientBlockRead(IntPtr hPeerDist, IntPtr hContentHandle, uint cbMaxNumberOfBytes, IntPtr pBuffer, uint dwTimeoutInMilliseconds, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PeerDist_PeerDistClientBlockRead' -Namespace Win32 -PassThru
# $api::PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
#uselib "PeerDist.dll"
#func global PeerDistClientBlockRead "PeerDistClientBlockRead" sptr, sptr, sptr, sptr, sptr, sptr
; PeerDistClientBlockRead hPeerDist, hContentHandle, cbMaxNumberOfBytes, varptr(pBuffer), dwTimeoutInMilliseconds, varptr(lpOverlapped)   ; 戻り値は stat
; hPeerDist : INT_PTR -> "sptr"
; hContentHandle : INT_PTR -> "sptr"
; cbMaxNumberOfBytes : DWORD -> "sptr"
; pBuffer : BYTE* optional, out -> "sptr"
; dwTimeoutInMilliseconds : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "PeerDist.dll"
#cfunc global PeerDistClientBlockRead "PeerDistClientBlockRead" sptr, sptr, int, var, int, var
; res = PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
; hPeerDist : INT_PTR -> "sptr"
; hContentHandle : INT_PTR -> "sptr"
; cbMaxNumberOfBytes : DWORD -> "int"
; pBuffer : BYTE* optional, out -> "var"
; dwTimeoutInMilliseconds : DWORD -> "int"
; lpOverlapped : OVERLAPPED* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD PeerDistClientBlockRead(INT_PTR hPeerDist, INT_PTR hContentHandle, DWORD cbMaxNumberOfBytes, BYTE* pBuffer, DWORD dwTimeoutInMilliseconds, OVERLAPPED* lpOverlapped)
#uselib "PeerDist.dll"
#cfunc global PeerDistClientBlockRead "PeerDistClientBlockRead" intptr, intptr, int, var, int, var
; res = PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
; hPeerDist : INT_PTR -> "intptr"
; hContentHandle : INT_PTR -> "intptr"
; cbMaxNumberOfBytes : DWORD -> "int"
; pBuffer : BYTE* optional, out -> "var"
; dwTimeoutInMilliseconds : DWORD -> "int"
; lpOverlapped : OVERLAPPED* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	peerdist = windows.NewLazySystemDLL("PeerDist.dll")
	procPeerDistClientBlockRead = peerdist.NewProc("PeerDistClientBlockRead")
)

// hPeerDist (INT_PTR), hContentHandle (INT_PTR), cbMaxNumberOfBytes (DWORD), pBuffer (BYTE* optional, out), dwTimeoutInMilliseconds (DWORD), lpOverlapped (OVERLAPPED*)
r1, _, err := procPeerDistClientBlockRead.Call(
	uintptr(hPeerDist),
	uintptr(hContentHandle),
	uintptr(cbMaxNumberOfBytes),
	uintptr(pBuffer),
	uintptr(dwTimeoutInMilliseconds),
	uintptr(lpOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PeerDistClientBlockRead(
  hPeerDist: NativeInt;   // INT_PTR
  hContentHandle: NativeInt;   // INT_PTR
  cbMaxNumberOfBytes: DWORD;   // DWORD
  pBuffer: Pointer;   // BYTE* optional, out
  dwTimeoutInMilliseconds: DWORD;   // DWORD
  lpOverlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'PeerDist.dll' name 'PeerDistClientBlockRead';
result := DllCall("PeerDist\PeerDistClientBlockRead"
    , "Ptr", hPeerDist   ; INT_PTR
    , "Ptr", hContentHandle   ; INT_PTR
    , "UInt", cbMaxNumberOfBytes   ; DWORD
    , "Ptr", pBuffer   ; BYTE* optional, out
    , "UInt", dwTimeoutInMilliseconds   ; DWORD
    , "Ptr", lpOverlapped   ; OVERLAPPED*
    , "UInt")   ; return: DWORD
●PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped) = DLL("PeerDist.dll", "dword PeerDistClientBlockRead(int, int, dword, void*, dword, void*)")
# 呼び出し: PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
# hPeerDist : INT_PTR -> "int"
# hContentHandle : INT_PTR -> "int"
# cbMaxNumberOfBytes : DWORD -> "dword"
# pBuffer : BYTE* optional, out -> "void*"
# dwTimeoutInMilliseconds : DWORD -> "dword"
# lpOverlapped : OVERLAPPED* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "peerdist" fn PeerDistClientBlockRead(
    hPeerDist: isize, // INT_PTR
    hContentHandle: isize, // INT_PTR
    cbMaxNumberOfBytes: u32, // DWORD
    pBuffer: [*c]u8, // BYTE* optional, out
    dwTimeoutInMilliseconds: u32, // DWORD
    lpOverlapped: [*c]OVERLAPPED // OVERLAPPED*
) callconv(std.os.windows.WINAPI) u32;
proc PeerDistClientBlockRead(
    hPeerDist: int,  # INT_PTR
    hContentHandle: int,  # INT_PTR
    cbMaxNumberOfBytes: uint32,  # DWORD
    pBuffer: ptr uint8,  # BYTE* optional, out
    dwTimeoutInMilliseconds: uint32,  # DWORD
    lpOverlapped: ptr OVERLAPPED  # OVERLAPPED*
): uint32 {.importc: "PeerDistClientBlockRead", stdcall, dynlib: "PeerDist.dll".}
pragma(lib, "peerdist");
extern(Windows)
uint PeerDistClientBlockRead(
    ptrdiff_t hPeerDist,   // INT_PTR
    ptrdiff_t hContentHandle,   // INT_PTR
    uint cbMaxNumberOfBytes,   // DWORD
    ubyte* pBuffer,   // BYTE* optional, out
    uint dwTimeoutInMilliseconds,   // DWORD
    OVERLAPPED* lpOverlapped   // OVERLAPPED*
);
ccall((:PeerDistClientBlockRead, "PeerDist.dll"), stdcall, UInt32,
      (Int, Int, UInt32, Ptr{UInt8}, UInt32, Ptr{OVERLAPPED}),
      hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
# hPeerDist : INT_PTR -> Int
# hContentHandle : INT_PTR -> Int
# cbMaxNumberOfBytes : DWORD -> UInt32
# pBuffer : BYTE* optional, out -> Ptr{UInt8}
# dwTimeoutInMilliseconds : DWORD -> UInt32
# lpOverlapped : OVERLAPPED* -> Ptr{OVERLAPPED}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PeerDistClientBlockRead(
    intptr_t hPeerDist,
    intptr_t hContentHandle,
    uint32_t cbMaxNumberOfBytes,
    uint8_t* pBuffer,
    uint32_t dwTimeoutInMilliseconds,
    void* lpOverlapped);
]]
local peerdist = ffi.load("peerdist")
-- peerdist.PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
-- hPeerDist : INT_PTR
-- hContentHandle : INT_PTR
-- cbMaxNumberOfBytes : DWORD
-- pBuffer : BYTE* optional, out
-- dwTimeoutInMilliseconds : DWORD
-- lpOverlapped : OVERLAPPED*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('PeerDist.dll');
const PeerDistClientBlockRead = lib.func('__stdcall', 'PeerDistClientBlockRead', 'uint32_t', ['intptr_t', 'intptr_t', 'uint32_t', 'uint8_t *', 'uint32_t', 'void *']);
// PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
// hPeerDist : INT_PTR -> 'intptr_t'
// hContentHandle : INT_PTR -> 'intptr_t'
// cbMaxNumberOfBytes : DWORD -> 'uint32_t'
// pBuffer : BYTE* optional, out -> 'uint8_t *'
// dwTimeoutInMilliseconds : DWORD -> 'uint32_t'
// lpOverlapped : OVERLAPPED* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("PeerDist.dll", {
  PeerDistClientBlockRead: { parameters: ["isize", "isize", "u32", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
// hPeerDist : INT_PTR -> "isize"
// hContentHandle : INT_PTR -> "isize"
// cbMaxNumberOfBytes : DWORD -> "u32"
// pBuffer : BYTE* optional, out -> "pointer"
// dwTimeoutInMilliseconds : DWORD -> "u32"
// lpOverlapped : OVERLAPPED* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PeerDistClientBlockRead(
    intptr_t hPeerDist,
    intptr_t hContentHandle,
    uint32_t cbMaxNumberOfBytes,
    uint8_t* pBuffer,
    uint32_t dwTimeoutInMilliseconds,
    void* lpOverlapped);
C, "PeerDist.dll");
// $ffi->PeerDistClientBlockRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped);
// hPeerDist : INT_PTR
// hContentHandle : INT_PTR
// cbMaxNumberOfBytes : DWORD
// pBuffer : BYTE* optional, out
// dwTimeoutInMilliseconds : DWORD
// lpOverlapped : OVERLAPPED*
// 構造体/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 Peerdist extends StdCallLibrary {
    Peerdist INSTANCE = Native.load("peerdist", Peerdist.class);
    int PeerDistClientBlockRead(
        long hPeerDist,   // INT_PTR
        long hContentHandle,   // INT_PTR
        int cbMaxNumberOfBytes,   // DWORD
        byte[] pBuffer,   // BYTE* optional, out
        int dwTimeoutInMilliseconds,   // DWORD
        Pointer lpOverlapped   // OVERLAPPED*
    );
}
@[Link("peerdist")]
lib LibPeerDist
  fun PeerDistClientBlockRead = PeerDistClientBlockRead(
    hPeerDist : LibC::SSizeT,   # INT_PTR
    hContentHandle : LibC::SSizeT,   # INT_PTR
    cbMaxNumberOfBytes : UInt32,   # DWORD
    pBuffer : UInt8*,   # BYTE* optional, out
    dwTimeoutInMilliseconds : UInt32,   # DWORD
    lpOverlapped : OVERLAPPED*   # OVERLAPPED*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PeerDistClientBlockReadNative = Uint32 Function(IntPtr, IntPtr, Uint32, Pointer<Uint8>, Uint32, Pointer<Void>);
typedef PeerDistClientBlockReadDart = int Function(int, int, int, Pointer<Uint8>, int, Pointer<Void>);
final PeerDistClientBlockRead = DynamicLibrary.open('PeerDist.dll')
    .lookupFunction<PeerDistClientBlockReadNative, PeerDistClientBlockReadDart>('PeerDistClientBlockRead');
// hPeerDist : INT_PTR -> IntPtr
// hContentHandle : INT_PTR -> IntPtr
// cbMaxNumberOfBytes : DWORD -> Uint32
// pBuffer : BYTE* optional, out -> Pointer<Uint8>
// dwTimeoutInMilliseconds : DWORD -> Uint32
// lpOverlapped : OVERLAPPED* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PeerDistClientBlockRead(
  hPeerDist: NativeInt;   // INT_PTR
  hContentHandle: NativeInt;   // INT_PTR
  cbMaxNumberOfBytes: DWORD;   // DWORD
  pBuffer: Pointer;   // BYTE* optional, out
  dwTimeoutInMilliseconds: DWORD;   // DWORD
  lpOverlapped: Pointer   // OVERLAPPED*
): DWORD; stdcall;
  external 'PeerDist.dll' name 'PeerDistClientBlockRead';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PeerDistClientBlockRead"
  c_PeerDistClientBlockRead :: CIntPtr -> CIntPtr -> Word32 -> Ptr Word8 -> Word32 -> Ptr () -> IO Word32
-- hPeerDist : INT_PTR -> CIntPtr
-- hContentHandle : INT_PTR -> CIntPtr
-- cbMaxNumberOfBytes : DWORD -> Word32
-- pBuffer : BYTE* optional, out -> Ptr Word8
-- dwTimeoutInMilliseconds : DWORD -> Word32
-- lpOverlapped : OVERLAPPED* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let peerdistclientblockread =
  foreign "PeerDistClientBlockRead"
    (intptr_t @-> intptr_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hPeerDist : INT_PTR -> intptr_t *)
(* hContentHandle : INT_PTR -> intptr_t *)
(* cbMaxNumberOfBytes : DWORD -> uint32_t *)
(* pBuffer : BYTE* optional, out -> (ptr uint8_t) *)
(* dwTimeoutInMilliseconds : DWORD -> uint32_t *)
(* lpOverlapped : OVERLAPPED* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library peerdist (t "PeerDist.dll"))
(cffi:use-foreign-library peerdist)

(cffi:defcfun ("PeerDistClientBlockRead" peer-dist-client-block-read :convention :stdcall) :uint32
  (h-peer-dist :int64)   ; INT_PTR
  (h-content-handle :int64)   ; INT_PTR
  (cb-max-number-of-bytes :uint32)   ; DWORD
  (p-buffer :pointer)   ; BYTE* optional, out
  (dw-timeout-in-milliseconds :uint32)   ; DWORD
  (lp-overlapped :pointer))   ; OVERLAPPED*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PeerDistClientBlockRead = Win32::API::More->new('PeerDist',
    'DWORD PeerDistClientBlockRead(LPARAM hPeerDist, LPARAM hContentHandle, DWORD cbMaxNumberOfBytes, LPVOID pBuffer, DWORD dwTimeoutInMilliseconds, LPVOID lpOverlapped)');
# my $ret = $PeerDistClientBlockRead->Call($hPeerDist, $hContentHandle, $cbMaxNumberOfBytes, $pBuffer, $dwTimeoutInMilliseconds, $lpOverlapped);
# hPeerDist : INT_PTR -> LPARAM
# hContentHandle : INT_PTR -> LPARAM
# cbMaxNumberOfBytes : DWORD -> DWORD
# pBuffer : BYTE* optional, out -> LPVOID
# dwTimeoutInMilliseconds : DWORD -> DWORD
# lpOverlapped : OVERLAPPED* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型