ホーム › Security.Credentials › CredIsProtectedW

CredIsProtectedW

関数

資格情報文字列が保護されているか判定する。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CredIsProtectedW(
    LPWSTR pszProtectedCredentials,
    CRED_PROTECTION_TYPE* pProtectionType
);

パラメーター

名前	型	方向	説明
pszProtectedCredentials	LPWSTR	in	テスト対象の資格情報を指定する、null 終端文字列へのポインター。
pProtectionType	CRED_PROTECTION_TYPE*	out	pszProtectedCredentials パラメーターで指定された資格情報が保護されているかどうかを指定する、CRED_PROTECTION_TYPE 列挙体の値へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定された資格情報が、以前の CredProtect 関数の呼び出しによって暗号化されているかどうかを指定します。(Unicode)

戻り値

関数が成功した場合は TRUE、それ以外の場合は FALSE を返します。

拡張エラー情報を取得するには、 GetLastError 関数を呼び出してください。

解説(Remarks)

メモ

wincred.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CredIsProtected を定義します。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存しないわけではないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL CredIsProtectedW(
    LPWSTR pszProtectedCredentials,
    CRED_PROTECTION_TYPE* pProtectionType
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredIsProtectedW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszProtectedCredentials,   // LPWSTR
    out int pProtectionType   // CRED_PROTECTION_TYPE* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredIsProtectedW(
    <MarshalAs(UnmanagedType.LPWStr)> pszProtectedCredentials As String,   ' LPWSTR
    <Out> ByRef pProtectionType As Integer   ' CRED_PROTECTION_TYPE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszProtectedCredentials : LPWSTR
' pProtectionType : CRED_PROTECTION_TYPE* out
Declare PtrSafe Function CredIsProtectedW Lib "advapi32" ( _
    ByVal pszProtectedCredentials As LongPtr, _
    ByRef pProtectionType As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredIsProtectedW = ctypes.windll.advapi32.CredIsProtectedW
CredIsProtectedW.restype = wintypes.BOOL
CredIsProtectedW.argtypes = [
    wintypes.LPCWSTR,  # pszProtectedCredentials : LPWSTR
    ctypes.c_void_p,  # pProtectionType : CRED_PROTECTION_TYPE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredIsProtectedW = Fiddle::Function.new(
  lib['CredIsProtectedW'],
  [
    Fiddle::TYPE_VOIDP,  # pszProtectedCredentials : LPWSTR
    Fiddle::TYPE_VOIDP,  # pProtectionType : CRED_PROTECTION_TYPE* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CredIsProtectedW(
        pszProtectedCredentials: *mut u16,  // LPWSTR
        pProtectionType: *mut i32  // CRED_PROTECTION_TYPE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CredIsProtectedW([MarshalAs(UnmanagedType.LPWStr)] string pszProtectedCredentials, out int pProtectionType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredIsProtectedW' -Namespace Win32 -PassThru
# $api::CredIsProtectedW(pszProtectedCredentials, pProtectionType)

#uselib "ADVAPI32.dll"
#func global CredIsProtectedW "CredIsProtectedW" wptr, wptr
; CredIsProtectedW pszProtectedCredentials, varptr(pProtectionType)   ; 戻り値は stat
; pszProtectedCredentials : LPWSTR -> "wptr"
; pProtectionType : CRED_PROTECTION_TYPE* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CredIsProtectedW "CredIsProtectedW" wstr, var
; res = CredIsProtectedW(pszProtectedCredentials, pProtectionType)
; pszProtectedCredentials : LPWSTR -> "wstr"
; pProtectionType : CRED_PROTECTION_TYPE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CredIsProtectedW "CredIsProtectedW" wstr, sptr
; res = CredIsProtectedW(pszProtectedCredentials, varptr(pProtectionType))
; pszProtectedCredentials : LPWSTR -> "wstr"
; pProtectionType : CRED_PROTECTION_TYPE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。