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

PeerDistClientStreamRead

関数
クライアントのコンテンツからストリームを読み取る。
DLLPeerDist.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

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

パラメーター

名前型方向説明
hPeerDistINT_PTRinPeerDistStartup によって返された PEERDIST_INSTANCE_HANDLE。
hContentHandleINT_PTRinPeerDistClientOpenContent 関数の呼び出しによって開かれたコンテンツハンドル。
cbMaxNumberOfBytesDWORDin読み取る最大バイト数。cbMaxNumberOfBytesToRead が 0 の場合は、PeerDistClientStreamRead 関数が、現在のストリーム読み取りオフセットにおいてローカルキャッシュ内で連続して利用できるコンテンツのバイト数を照会することを示します。この照会では、ピアからコンテンツをダウンロードすることも、ピアキャッシュ内に存在するバイト数を返すこともありません。
pBufferBYTE*outoptionalローカルキャッシュからのデータを受け取るバッファーへのポインター。このバッファーは、読み取り操作が続いている間は有効なままである必要があります。呼び出し元は、読み取り操作が完了するまでこのバッファーを使用してはなりません。cbMaxNumberOfBytesToRead 引数が 0 の場合、pBuffer パラメーターは NULL にできます。
dwTimeoutInMillisecondsDWORDin

読み取りのタイムアウト値 (ミリ秒単位)。 指定できる特別な値が 2 つあります。

値 意味
PEERDIST_READ_TIMEOUT_LOCAL_CACHE_ONLY
読み取りによって、ピアやホストされたキャッシュ (Hosted Cache) への接続などの追加のネットワークトラフィックを発生させないことを指定します。
PEERDIST_READ_TIMEOUT_DEFAULT
既定のタイムアウトである 5 秒を指定します。
lpOverlappedOVERLAPPED*inOVERLAPPED 構造体へのポインター。ストリーム読み取りでは、呼び出し元が読み取りの開始 Offset を指定することはできません。次のストリーム読み取りオフセットは、hContentHandle ごとに暗黙的に管理されます。

戻り値の型: DWORD

公式ドキュメント

PeerDistClientStreamRead は、コンテンツストリームから一連のバイトを読み取ります。

戻り値

関数が成功した場合、戻り値は ERROR_IO_PENDING です。それ以外の場合、関数は次のいずれかの値を返すことがあります。

リターンコード 説明
ERROR_INVALID_PARAMETER
1 つ以上のパラメーターが無効です。
ERROR_INVALID_HANDLE
hPeerDist ハンドルまたは hContent ハンドルが無効です。
ERROR_ACCESS_DISABLED_BY_POLICY
この機能はグループポリシーによって無効にされています。
PEERDIST_ERROR_SERVICE_UNAVAILABLE
サービスが利用できません。

解説(Remarks)

PeerDistClientStreamRead は読み取りをキューに入れ、直ちに呼び出し元に制御を返します。 そのため、複数の読み取りを同時に発行でき、データバッファーは先入れ先出し方式で使用されます。 PeerDistClientStreamRead は、データが少しでも利用可能になった時点で読み取りを完了し、バッファーが完全に満たされるまで待機しません。

PeerDistClientStreamRead 関数の操作が正常に完了すると、OVERLAPPED 構造体の Offset フィールドと OffsetHigh フィールドには、読み取りが開始された ULONGLONG のオフセットが設定されます。 OffsetHigh メンバーにはオフセットの上位 32 ビットが設定され、Offset メンバーにはオフセットの下位 32 ビットが設定されます。GetOverlappedResult は、転送されたバイト数を lpNumberOfBytesTransferred に設定します。呼び出し元が完了ポートを使用して Peer Distribution API の完了を処理している場合は、GetQueuedCompletionStatus の lpNumberOfBytes 引数に転送されたバイト数が設定されます。 ストリームのオフセットは、読み取られたと報告されたバイト数だけ進みます。4GB を超えるコンテンツについて利用可能なコンテンツの長さを照会するには、PeerDistClientBlockRead に cbMaxNumberOfBytesToRead として 0 と適切なオフセットを指定して使用できます。

API がエラー値 PEERDIST_ERROR_MISSING_DATA または ERROR_TIMEOUT で完了した場合、OVERLAPPED 構造体の Offset フィールドと OffsetHigh フィールドは、欠落しているデータ範囲が始まる ULONGLONG のオフセットを示します。 OffsetHigh メンバーにはオフセットの上位 32 ビットが設定され、Offset メンバーにはオフセットの下位 32 ビットが設定されます。この欠落データ範囲とは、元のコンテンツサーバーなどの代替ソースから取得する必要がある、(コンテンツの先頭を基準とした) 開始オフセットと長さ (バイト単位) です。今後、同じ読み取りを Peer Distribution サービスが処理できるようにするには、PeerDistClientAddData を呼び出して、このデータをローカルキャッシュに追加します。欠落データ範囲の長さは、転送されたバイト数 (GetQueuedCompletionStatus または GetOverlappedResult によって取得) によって示されます。 ストリームのオフセットは、欠落データ範囲の長さとして報告されたバイト数だけ進みます。

ストリームのオフセットがコンテンツの終端を超えて進んだ後に PeerDistClientStreamRead を呼び出した場合、API は ERROR_NO_MORE で完了します。

欠落データ範囲は、コンテンツ内の任意のオフセットから始まり、コンテンツの終端までの任意の長さになり得る点に注意することが重要です。PeerDistClientAddContentInformation に渡されたコンテンツ情報が範囲要求に応じて生成されたものである場合、欠落データ範囲は範囲要求の境界内に制限されます。これは、コンテンツサーバー上の PeerDistServerOpenContentInformation の呼び出しで、コンテンツ全体のうちの部分範囲となるオフセットと長さが指定された場合に発生します。 この場合に ERROR_NO_MORE で完了することは、読み取りオフセットがコンテンツの部分範囲外にあることを示します。

範囲要求

クライアントが元のコンテンツの一部分のみを必要とする場合、範囲要求を使用してその部分を取得できます。範囲要求には、元のコンテンツのオフセットと長さが含まれます。コンテンツ情報のサイズは、要求されたコンテンツのサイズに正比例します。

PeerDistServerOpenContentInformation は、ullContentOffset パラメーターと cbContentLength パラメーターによって、範囲要求用のコンテンツ情報の生成をサポートします。ullContentOffset パラメーターは元のコンテンツ内で範囲が始まるオフセットを表し、cbContentLength は範囲の長さを表します。

クライアントが特定のコンテンツ範囲を表すコンテンツ情報を取得すると、そのコンテンツ情報は PeerDistClientOpenContent、PeerDistClientAddContentInformation、PeerDistClientCompleteContentInformation の各 API とシームレスに連携します。 このコンテンツ情報は PeerDistServerOpenContentInformation に渡すことができ、PEERDIST_CONTENT_HANDLE がそのコンテンツ範囲に関連付けられます。 PeerDistClientStreamRead は、サーバー側の PeerDistServerRetrieveContentInformation の呼び出しで指定された ullContentOffset オフセットと cbContentLength の長さによって制約されます。 PeerDistClientStreamRead は ullContentOffset から開始し、ullContentOffset + cbContentLength でコンテンツ範囲の終端に達すると、エラーコード PEERDIST_ERROR_NO_MORE で完了します。 PeerDistClientBlockRead は、OVERLAPPED パラメーターで指定されたオフセットが ullContentOffset 未満、または ullContentOffset + cbContentLength を超える場合、エラーコード PEERDIST_ERROR_NO_MORE で完了します。 PeerDistClientStreamRead と PeerDistClientBlockRead はいずれも、報告する欠落データの量を、PEERDIST_CONTENT_HANDLE に関連付けられたコンテンツ情報で指定されたコンテンツ範囲に制限します。 たとえば、コンテンツ情報がコンテンツの前半のみを表している場合、欠落データはコンテンツの前半に限定されます。 その他のすべての点において、PeerDistClientBlockRead と PeerDistClientStreamRead は、コンテンツ全体を扱う場合とまったく同じ方法でコンテンツ範囲を扱います。

クライアントは、PeerDistClientStreamRead または PeerDistClientBlockRead を使用して、PeerDistServerRetrieveContentInformation の呼び出しで ullContentOffset に指定したオフセットから、cbContentLength に指定した長さまでのコンテンツを取得できます。PeerDistClientStreamRead と PeerDistClientBlockRead はいずれも、クライアントが ullContentOffset と cbContentLength で指定された範囲を超えて読み取ろうとした場合、PEERDIST_ERROR_NO_MORE で完了します。さらに PeerDistClientBlockRead は、OVERLAPPED パラメーターで指定されたオフセットが ullContentOffset 未満の場合にも、エラーコード PEERDIST_ERROR_NO_MORE で完了します。

ローカルキャッシュからもピアキャッシュからも読み取りを完了できない場合、PeerDistClientStreamRead と PeerDistClientBlockRead はどちらも PEERDIST_ERROR_MISSING_DATA を報告します。範囲指定されたコンテンツ情報を使用している場合、PeerDistClientStreamRead は範囲の開始オフセットから範囲の終端までを欠落データとして報告します。PeerDistClientBlockRead も、範囲の開始オフセットから範囲の終端までを欠落データとして報告します。

PeerDistClientAddData では、コンテンツ範囲の外側にあるコンテンツデータも追加できます。 この範囲外のデータは、対応するコンテンツ情報がローカルキャッシュに追加された後に検証されます。 検証されると、そのデータはピアから利用できるようになります。 言い換えると、クライアントがコンテンツの前半のコンテンツ情報のみを追加した場合でも、PeerDistClientAddData によってコンテンツ全体のデータを追加できます。 ただし、コンテンツの後半は、対応する後半のコンテンツ情報が追加されるまで検証されません。 範囲要求の影響を受ける Peer Distribution API は他にはありません。

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

各言語での呼び出し定義

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

DWORD PeerDistClientStreamRead(
    INT_PTR hPeerDist,
    INT_PTR hContentHandle,
    DWORD cbMaxNumberOfBytes,
    BYTE* pBuffer,   // optional
    DWORD dwTimeoutInMilliseconds,
    OVERLAPPED* lpOverlapped
);
[DllImport("PeerDist.dll", ExactSpelling = true)]
static extern uint PeerDistClientStreamRead(
    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 PeerDistClientStreamRead(
    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 PeerDistClientStreamRead 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

PeerDistClientStreamRead = ctypes.windll.peerdist.PeerDistClientStreamRead
PeerDistClientStreamRead.restype = wintypes.DWORD
PeerDistClientStreamRead.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')
PeerDistClientStreamRead = Fiddle::Function.new(
  lib['PeerDistClientStreamRead'],
  [
    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 PeerDistClientStreamRead(
        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 PeerDistClientStreamRead(IntPtr hPeerDist, IntPtr hContentHandle, uint cbMaxNumberOfBytes, IntPtr pBuffer, uint dwTimeoutInMilliseconds, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PeerDist_PeerDistClientStreamRead' -Namespace Win32 -PassThru
# $api::PeerDistClientStreamRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped)
#uselib "PeerDist.dll"
#func global PeerDistClientStreamRead "PeerDistClientStreamRead" sptr, sptr, sptr, sptr, sptr, sptr
; PeerDistClientStreamRead 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 PeerDistClientStreamRead "PeerDistClientStreamRead" sptr, sptr, int, var, int, var
; res = PeerDistClientStreamRead(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 PeerDistClientStreamRead(INT_PTR hPeerDist, INT_PTR hContentHandle, DWORD cbMaxNumberOfBytes, BYTE* pBuffer, DWORD dwTimeoutInMilliseconds, OVERLAPPED* lpOverlapped)
#uselib "PeerDist.dll"
#cfunc global PeerDistClientStreamRead "PeerDistClientStreamRead" intptr, intptr, int, var, int, var
; res = PeerDistClientStreamRead(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")
	procPeerDistClientStreamRead = peerdist.NewProc("PeerDistClientStreamRead")
)

// hPeerDist (INT_PTR), hContentHandle (INT_PTR), cbMaxNumberOfBytes (DWORD), pBuffer (BYTE* optional, out), dwTimeoutInMilliseconds (DWORD), lpOverlapped (OVERLAPPED*)
r1, _, err := procPeerDistClientStreamRead.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 PeerDistClientStreamRead(
  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 'PeerDistClientStreamRead';
result := DllCall("PeerDist\PeerDistClientStreamRead"
    , "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
●PeerDistClientStreamRead(hPeerDist, hContentHandle, cbMaxNumberOfBytes, pBuffer, dwTimeoutInMilliseconds, lpOverlapped) = DLL("PeerDist.dll", "dword PeerDistClientStreamRead(int, int, dword, void*, dword, void*)")
# 呼び出し: PeerDistClientStreamRead(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 PeerDistClientStreamRead(
    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 PeerDistClientStreamRead(
    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: "PeerDistClientStreamRead", stdcall, dynlib: "PeerDist.dll".}
pragma(lib, "peerdist");
extern(Windows)
uint PeerDistClientStreamRead(
    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((:PeerDistClientStreamRead, "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 PeerDistClientStreamRead(
    intptr_t hPeerDist,
    intptr_t hContentHandle,
    uint32_t cbMaxNumberOfBytes,
    uint8_t* pBuffer,
    uint32_t dwTimeoutInMilliseconds,
    void* lpOverlapped);
]]
local peerdist = ffi.load("peerdist")
-- peerdist.PeerDistClientStreamRead(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 PeerDistClientStreamRead = lib.func('__stdcall', 'PeerDistClientStreamRead', 'uint32_t', ['intptr_t', 'intptr_t', 'uint32_t', 'uint8_t *', 'uint32_t', 'void *']);
// PeerDistClientStreamRead(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", {
  PeerDistClientStreamRead: { parameters: ["isize", "isize", "u32", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.PeerDistClientStreamRead(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 PeerDistClientStreamRead(
    intptr_t hPeerDist,
    intptr_t hContentHandle,
    uint32_t cbMaxNumberOfBytes,
    uint8_t* pBuffer,
    uint32_t dwTimeoutInMilliseconds,
    void* lpOverlapped);
C, "PeerDist.dll");
// $ffi->PeerDistClientStreamRead(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 PeerDistClientStreamRead(
        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 PeerDistClientStreamRead = PeerDistClientStreamRead(
    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 PeerDistClientStreamReadNative = Uint32 Function(IntPtr, IntPtr, Uint32, Pointer<Uint8>, Uint32, Pointer<Void>);
typedef PeerDistClientStreamReadDart = int Function(int, int, int, Pointer<Uint8>, int, Pointer<Void>);
final PeerDistClientStreamRead = DynamicLibrary.open('PeerDist.dll')
    .lookupFunction<PeerDistClientStreamReadNative, PeerDistClientStreamReadDart>('PeerDistClientStreamRead');
// 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 PeerDistClientStreamRead(
  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 'PeerDistClientStreamRead';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PeerDistClientStreamRead"
  c_PeerDistClientStreamRead :: 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 peerdistclientstreamread =
  foreign "PeerDistClientStreamRead"
    (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 ("PeerDistClientStreamRead" peer-dist-client-stream-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 $PeerDistClientStreamRead = Win32::API::More->new('PeerDist',
    'DWORD PeerDistClientStreamRead(LPARAM hPeerDist, LPARAM hContentHandle, DWORD cbMaxNumberOfBytes, LPVOID pBuffer, DWORD dwTimeoutInMilliseconds, LPVOID lpOverlapped)');
# my $ret = $PeerDistClientStreamRead->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 を使用。

関連項目

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