ホーム › Security.Credentials › CredIsProtectedA

CredIsProtectedA

関数

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

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

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CredIsProtectedA(
    LPSTR pszProtectedCredentials,
    CRED_PROTECTION_TYPE* pProtectionType
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合は 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  (ANSI / -A)
#include <windows.h>

BOOL CredIsProtectedA(
    LPSTR pszProtectedCredentials,
    CRED_PROTECTION_TYPE* pProtectionType
);

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

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

' pszProtectedCredentials : LPSTR
' pProtectionType : CRED_PROTECTION_TYPE* out
Declare PtrSafe Function CredIsProtectedA Lib "advapi32" ( _
    ByVal pszProtectedCredentials As String, _
    ByRef pProtectionType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredIsProtectedA = ctypes.windll.advapi32.CredIsProtectedA
CredIsProtectedA.restype = wintypes.BOOL
CredIsProtectedA.argtypes = [
    wintypes.LPCSTR,  # pszProtectedCredentials : LPSTR
    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')
CredIsProtectedA = Fiddle::Function.new(
  lib['CredIsProtectedA'],
  [
    Fiddle::TYPE_VOIDP,  # pszProtectedCredentials : LPSTR
    Fiddle::TYPE_VOIDP,  # pProtectionType : CRED_PROTECTION_TYPE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CredIsProtectedA(
        pszProtectedCredentials: *mut u8,  // LPSTR
        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.Ansi, SetLastError = true)]
public static extern bool CredIsProtectedA([MarshalAs(UnmanagedType.LPStr)] string pszProtectedCredentials, out int pProtectionType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredIsProtectedA' -Namespace Win32 -PassThru
# $api::CredIsProtectedA(pszProtectedCredentials, pProtectionType)

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

出力引数:

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