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

WINHTTP_CREDS

構造体
サイズx64: 48 バイト / x86: 24 バイト

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

フィールド

フィールドサイズx64x86説明
lpszUserNameLPSTR8/4+0+0ユーザー名を格納するバッファーへのポインターです。
lpszPasswordLPSTR8/4+8+4パスワードを格納するバッファーへのポインターです。
lpszRealmLPSTR8/4+16+8レルムを格納するバッファーへのポインターです。
dwAuthSchemeWINHTTP_CREDS_AUTHSCHEME4+24+12

認証スキームを格納するフラグで、次のいずれかの値を指定します。

意味
WINHTTP_AUTH_SCHEME_BASIC
基本認証を使用します。
WINHTTP_AUTH_SCHEME_NTLM
NTLM 認証を使用します。
INHTTP_AUTH_SCHEME_DIGEST
ダイジェスト認証を使用します。
WINHTTP_AUTH_SCHEME_NEGOTIATE
NTLM 認証と Kerberos 認証のいずれかを選択します。
lpszHostNameLPSTR8/4+32+16ホスト名を格納するバッファーへのポインターです。
dwPortDWORD4+40+20サーバーへの接続に使用するポートです。

公式ドキュメント

WINHTTP_CREDS 構造体は、サーバーおよびプロキシの認証に使用されるユーザー資格情報を格納します。

メモ この構造体は非推奨です。代わりに WINHTTP_CREDS_EX 構造体を使用することをお勧めします。

解説(Remarks)

この構造体は、WINHTTP_OPTION_GLOBAL_SERVER_CREDS および WINHTTP_OPTION_GLOBAL_PROXY_CREDSオプションフラグと共に使用します。これらのオプションには、レジストリキー HKLM\Software\Microsoft\Windows\CurrentVersion\Internet Settings!ShareCredsWithWinHttp が必要です。このレジストリキーは既定では存在しません。

このキーが設定されていると、WinINet は資格情報を WinHTTP に渡します。WinHTTP は認証チャレンジを受け取った際に、現在のハンドルに資格情報が設定されていない場合、WinINet から提供された資格情報を使用します。プロキシの資格情報に加えてサーバーの資格情報も共有するには、WINHTTP_OPTION_USE_GLOBAL_SERVER_CREDENTIALS オプションフラグを設定する必要があります。

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

各言語での定義

#include <windows.h>

// WINHTTP_CREDS  (x64 48 / x86 24 バイト)
typedef struct WINHTTP_CREDS {
    LPSTR lpszUserName;
    LPSTR lpszPassword;
    LPSTR lpszRealm;
    WINHTTP_CREDS_AUTHSCHEME dwAuthScheme;
    LPSTR lpszHostName;
    DWORD dwPort;
} WINHTTP_CREDS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WINHTTP_CREDS
{
    public IntPtr lpszUserName;
    public IntPtr lpszPassword;
    public IntPtr lpszRealm;
    public uint dwAuthScheme;
    public IntPtr lpszHostName;
    public uint dwPort;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WINHTTP_CREDS
    Public lpszUserName As IntPtr
    Public lpszPassword As IntPtr
    Public lpszRealm As IntPtr
    Public dwAuthScheme As UInteger
    Public lpszHostName As IntPtr
    Public dwPort As UInteger
End Structure
import ctypes
from ctypes import wintypes

class WINHTTP_CREDS(ctypes.Structure):
    _fields_ = [
        ("lpszUserName", ctypes.c_void_p),
        ("lpszPassword", ctypes.c_void_p),
        ("lpszRealm", ctypes.c_void_p),
        ("dwAuthScheme", wintypes.DWORD),
        ("lpszHostName", ctypes.c_void_p),
        ("dwPort", wintypes.DWORD),
    ]
#[repr(C)]
pub struct WINHTTP_CREDS {
    pub lpszUserName: *mut core::ffi::c_void,
    pub lpszPassword: *mut core::ffi::c_void,
    pub lpszRealm: *mut core::ffi::c_void,
    pub dwAuthScheme: u32,
    pub lpszHostName: *mut core::ffi::c_void,
    pub dwPort: u32,
}
import "golang.org/x/sys/windows"

type WINHTTP_CREDS struct {
	lpszUserName uintptr
	lpszPassword uintptr
	lpszRealm uintptr
	dwAuthScheme uint32
	lpszHostName uintptr
	dwPort uint32
}
type
  WINHTTP_CREDS = record
    lpszUserName: Pointer;
    lpszPassword: Pointer;
    lpszRealm: Pointer;
    dwAuthScheme: DWORD;
    lpszHostName: Pointer;
    dwPort: DWORD;
  end;
const WINHTTP_CREDS = extern struct {
    lpszUserName: ?*anyopaque,
    lpszPassword: ?*anyopaque,
    lpszRealm: ?*anyopaque,
    dwAuthScheme: u32,
    lpszHostName: ?*anyopaque,
    dwPort: u32,
};
type
  WINHTTP_CREDS {.bycopy.} = object
    lpszUserName: pointer
    lpszPassword: pointer
    lpszRealm: pointer
    dwAuthScheme: uint32
    lpszHostName: pointer
    dwPort: uint32
struct WINHTTP_CREDS
{
    void* lpszUserName;
    void* lpszPassword;
    void* lpszRealm;
    uint dwAuthScheme;
    void* lpszHostName;
    uint dwPort;
}

HSP用 定義

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

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

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