Win32 API 日本語リファレンス
ホームUI.Shell › CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR

CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR

構造体
サイズx64: 32 バイト / x86: 28 バイト

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

フィールド

フィールドサイズx64x86説明
dwFieldIDDWORD4+0+0フィールドの一意な ID です。フィールドは、対象の資格情報プロバイダー上の他のすべてのフィールドと重複しない識別子を持つ必要があります。これは、フィールドが表示されているか非表示であるかにかかわらず当てはまります。
cpftCREDENTIAL_PROVIDER_FIELD_TYPE4+4+4フィールドの種類です。
pszLabelLPWSTR8/4+8+8フィールドのわかりやすい名前を null 終端の Unicode 文字列として格納するバッファーへのポインターです。これはアクセシビリティおよびキューイングの目的で使用されます。たとえば、標準的なフィールドのわかりやすい名前としては "Username"、"Password"、"Log On To" などがあります。
guidFieldTypeGUID16+16+12

フィールドの種類を一意に識別する GUID です。このメンバーを使用すると、既存の資格情報プロバイダーが提供する機能を独自のプロバイダーでラップできます。ただし、資格情報プロバイダーのラップは、組み込みの資格情報プロバイダーを無効にするなど予期しない動作を引き起こす可能性があるため、推奨されません。

次の表は、Windows でサポートされる guidFieldType の値を示します。これらは Shlguid.h で定義されています。

意味
CPFG_LOGON_USERNAME
da15bbe8-954sd-4fd3-b0f4-1fb5b90b174b
テキスト ボックスに入力されたユーザー名です。
CPFG_LOGON_PASSWORD
60624cfa-a477-47b1-8a8e-3a4a19981827
テキスト ボックスに入力されたパスワードです。
CPFG_SMARTCARD_USERNAME
3e1ecf69-568c-4d96-9d59-46444174e2d6
挿入されたスマート カードから取得したユーザー名です。
CPFG_SMARTCARD_PIN
4fe5263b-9181-46c1-b0a4-9dedd4db7dea
挿入されたスマート カードから取得した PIN です。
CPFG_CREDENTIAL_PROVIDER_LOGO
2d837775-f6cd-464e-a745-482fd0b47493
Windows 8 で導入: ログオン ページ上で資格情報プロバイダーを表す画像です。
CPFG_CREDENTIAL_PROVIDER_LABEL
286BBFF3-BAD4-438F-B007-79B7267C3D48
Windows 8 で導入: ログオン ページ上で資格情報プロバイダーに関連付けられるラベルです。

公式ドキュメント

資格情報内の単一のフィールド (文字列やユーザー画像など) を記述します。

解説(Remarks)

タイル上でユーザーに表示される各 UI 要素は、資格情報プロバイダーによってフィールドとして定義されます。CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR は、資格情報プロバイダーがそれらのフィールドを識別するための手段です。特定の使用シナリオ向けにフィールドを定義した後は、フィールドを追加したり削除したりすることはできません。資格情報プロバイダーは、タイルを列挙する前にすべてのフィールドを完全に定義しておく必要があります。資格情報の取得処理の中で表示されたり非表示になったりするフィールドについても、あらかじめ定義しておく必要があります。必要に応じてフィールドを表示または非表示にするには、CREDENTIAL_PROVIDER_FIELD_STATE を使用してください。

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

各言語での定義

#include <windows.h>

// CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR  (x64 32 / x86 28 バイト)
typedef struct CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR {
    DWORD dwFieldID;
    CREDENTIAL_PROVIDER_FIELD_TYPE cpft;
    LPWSTR pszLabel;
    GUID guidFieldType;
} CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR
{
    public uint dwFieldID;
    public int cpft;
    public IntPtr pszLabel;
    public Guid guidFieldType;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR
    Public dwFieldID As UInteger
    Public cpft As Integer
    Public pszLabel As IntPtr
    Public guidFieldType As Guid
End Structure
import ctypes
from ctypes import wintypes

class CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR(ctypes.Structure):
    _fields_ = [
        ("dwFieldID", wintypes.DWORD),
        ("cpft", ctypes.c_int),
        ("pszLabel", ctypes.c_void_p),
        ("guidFieldType", GUID),
    ]
#[repr(C)]
pub struct CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR {
    pub dwFieldID: u32,
    pub cpft: i32,
    pub pszLabel: *mut core::ffi::c_void,
    pub guidFieldType: GUID,
}
import "golang.org/x/sys/windows"

type CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR struct {
	dwFieldID uint32
	cpft int32
	pszLabel uintptr
	guidFieldType windows.GUID
}
type
  CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR = record
    dwFieldID: DWORD;
    cpft: Integer;
    pszLabel: Pointer;
    guidFieldType: TGUID;
  end;
const CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR = extern struct {
    dwFieldID: u32,
    cpft: i32,
    pszLabel: ?*anyopaque,
    guidFieldType: GUID,
};
type
  CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR {.bycopy.} = object
    dwFieldID: uint32
    cpft: int32
    pszLabel: pointer
    guidFieldType: GUID
struct CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR
{
    uint dwFieldID;
    int cpft;
    void* pszLabel;
    GUID guidFieldType;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR サイズ: 28 バイト(x86)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; dwFieldID : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; cpft : CREDENTIAL_PROVIDER_FIELD_TYPE (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pszLabel : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; guidFieldType : GUID (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR サイズ: 32 バイト(x64)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; dwFieldID : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; cpft : CREDENTIAL_PROVIDER_FIELD_TYPE (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pszLabel : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; guidFieldType : GUID (+16, 16byte)  varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR
    #field int dwFieldID
    #field int cpft
    #field intptr pszLabel
    #field GUID guidFieldType
#endstruct

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