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

BG_BASIC_CREDENTIALS

構造体
サイズx64: 16 バイト / x86: 8 バイト

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

フィールド

フィールドサイズx64x86説明
UserNameLPWSTR8/4+0+0

認証に使用するユーザー名を格納する null 終端文字列です。ユーザー名は、null 終端文字を含めずに 300 文字までに制限されます。ユーザー名の形式は、要求される認証スキームによって異なります。たとえば、Basic、NTLM、および Negotiate 認証の場合、ユーザー名は DomainName\UserName の形式です。Passport 認証の場合、ユーザー名は電子メールアドレスです。詳細については、「解説」を参照してください。

NULL の場合は、このセッションコンテキストの既定の資格情報が使用されます。

PasswordLPWSTR8/4+8+4

パスワードをプレーンテキストで格納する null 終端文字列です。パスワードは、null 終端文字を含めずに 65536 文字までに制限されます。パスワードは空でもかまいません。UserNameNULL の場合は、NULL に設定します。ネットワークの切断が発生した場合やユーザーがログオフした場合、BITS はジョブを保存する前にパスワードを暗号化します。

Live ID でエンコードされたパスワードは、Negotiate 2 を通じてサポートされます。Live ID の詳細については、Windows Live ID SDK を参照してください。

公式ドキュメント

認証に使用するユーザー名とパスワードを指定します。

解説(Remarks)

次の一覧は、要求される認証スキームに応じて UserName メンバーと Password メンバーが必要になる場合を示しています。

ユーザー名とパスワードの情報を保護するため、この構造体を使用した後は、Winbase.h で定義されている SecureZeroMemory 関数を呼び出して UserName バッファーと Password バッファーをクリアしてください。

ユーザー名は次のように指定できます。

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

各言語での定義

#include <windows.h>

// BG_BASIC_CREDENTIALS  (x64 16 / x86 8 バイト)
typedef struct BG_BASIC_CREDENTIALS {
    LPWSTR UserName;
    LPWSTR Password;
} BG_BASIC_CREDENTIALS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct BG_BASIC_CREDENTIALS
{
    public IntPtr UserName;
    public IntPtr Password;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure BG_BASIC_CREDENTIALS
    Public UserName As IntPtr
    Public Password As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class BG_BASIC_CREDENTIALS(ctypes.Structure):
    _fields_ = [
        ("UserName", ctypes.c_void_p),
        ("Password", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct BG_BASIC_CREDENTIALS {
    pub UserName: *mut core::ffi::c_void,
    pub Password: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type BG_BASIC_CREDENTIALS struct {
	UserName uintptr
	Password uintptr
}
type
  BG_BASIC_CREDENTIALS = record
    UserName: Pointer;
    Password: Pointer;
  end;
const BG_BASIC_CREDENTIALS = extern struct {
    UserName: ?*anyopaque,
    Password: ?*anyopaque,
};
type
  BG_BASIC_CREDENTIALS {.bycopy.} = object
    UserName: pointer
    Password: pointer
struct BG_BASIC_CREDENTIALS
{
    void* UserName;
    void* Password;
}

HSP用 定義

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

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

stdim st, BG_BASIC_CREDENTIALS        ; NSTRUCT 変数を確保