Win32 API 日本語リファレンス
ホーム › Networking.BackgroundIntelligentTransferService › BG_JOB_PROGRESS

BG_JOB_PROGRESS

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 24 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
BytesTotalULONGLONG8+0+0

ジョブ内のすべてのファイルについて転送する合計バイト数。値が BG_SIZE_UNKNOWN の場合、ジョブ内のすべてのファイルの合計サイズは確定していません。BITS は、いずれかのファイルのサイズを特定できない場合、この値を設定しません。たとえば、指定されたファイルまたはサーバーが存在しない場合、BITS はファイルのサイズを特定できません。

ファイルから範囲を指定してダウンロードする場合、BytesTotal にはそのファイルからダウンロードするバイトの合計数が含まれます。

BytesTransferredULONGLONG8+8+8転送されたバイト数。
FilesTotalDWORD4+16+16このジョブで転送するファイルの合計数。
FilesTransferredDWORD4+20+20転送されたファイル数。

公式ドキュメント

転送されたバイト数やファイル数など、ジョブに関連する進行状況の情報を提供します。アップロードジョブの場合、進行状況は応答ファイルではなくアップロードファイルに適用されます。応答ファイルの進行状況を確認するには、 BG_JOB_REPLY_PROGRESS 構造体を参照してください。

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

各言語での定義

#include <windows.h>

// BG_JOB_PROGRESS  (x64 24 / x86 24 バイト)
typedef struct BG_JOB_PROGRESS {
    ULONGLONG BytesTotal;
    ULONGLONG BytesTransferred;
    DWORD FilesTotal;
    DWORD FilesTransferred;
} BG_JOB_PROGRESS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct BG_JOB_PROGRESS
{
    public ulong BytesTotal;
    public ulong BytesTransferred;
    public uint FilesTotal;
    public uint FilesTransferred;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure BG_JOB_PROGRESS
    Public BytesTotal As ULong
    Public BytesTransferred As ULong
    Public FilesTotal As UInteger
    Public FilesTransferred As UInteger
End Structure
import ctypes
from ctypes import wintypes

class BG_JOB_PROGRESS(ctypes.Structure):
    _fields_ = [
        ("BytesTotal", ctypes.c_ulonglong),
        ("BytesTransferred", ctypes.c_ulonglong),
        ("FilesTotal", wintypes.DWORD),
        ("FilesTransferred", wintypes.DWORD),
    ]
#[repr(C)]
pub struct BG_JOB_PROGRESS {
    pub BytesTotal: u64,
    pub BytesTransferred: u64,
    pub FilesTotal: u32,
    pub FilesTransferred: u32,
}
import "golang.org/x/sys/windows"

type BG_JOB_PROGRESS struct {
	BytesTotal uint64
	BytesTransferred uint64
	FilesTotal uint32
	FilesTransferred uint32
}
type
  BG_JOB_PROGRESS = record
    BytesTotal: UInt64;
    BytesTransferred: UInt64;
    FilesTotal: DWORD;
    FilesTransferred: DWORD;
  end;
const BG_JOB_PROGRESS = extern struct {
    BytesTotal: u64,
    BytesTransferred: u64,
    FilesTotal: u32,
    FilesTransferred: u32,
};
type
  BG_JOB_PROGRESS {.bycopy.} = object
    BytesTotal: uint64
    BytesTransferred: uint64
    FilesTotal: uint32
    FilesTransferred: uint32
struct BG_JOB_PROGRESS
{
    ulong BytesTotal;
    ulong BytesTransferred;
    uint FilesTotal;
    uint FilesTransferred;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; BG_JOB_PROGRESS サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; BytesTotal : ULONGLONG (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; BytesTransferred : ULONGLONG (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; FilesTotal : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; FilesTransferred : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global BG_JOB_PROGRESS
    #field int64 BytesTotal
    #field int64 BytesTransferred
    #field int FilesTotal
    #field int FilesTransferred
#endstruct

stdim st, BG_JOB_PROGRESS        ; NSTRUCT 変数を確保
st->BytesTotal = 100
mes "BytesTotal=" + st->BytesTotal