Win32 API 日本語リファレンス
ホームSecurity.Credentials › CredUIReadSSOCredW

CredUIReadSSOCredW

関数
シングルサインオン用の資格情報のユーザー名を読み取る。
DLLcredui.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// credui.dll
#include <windows.h>

DWORD CredUIReadSSOCredW(
    LPCWSTR pszRealm,   // optional
    LPWSTR* ppszUsername
);

パラメーター

名前方向説明
pszRealmLPCWSTRinoptionalレルムを指定する null 終端文字列へのポインター。このパラメーターが NULL の場合は、既定のレルムが使用されます。
ppszUsernameLPWSTR*outnull 終端文字列へのポインターへのポインター。文字列の使用が終わったら、LocalFree 関数を呼び出して ppszUsername を解放してください。

戻り値の型: DWORD

公式ドキュメント

CredUIReadSSOCredW 関数は、単一のログオン資格情報のユーザー名を取得します。

戻り値

戻り値は DWORD です。次の表に、取り得る値を示します。

戻り値 説明
ERROR_SUCCESS
関数は成功しました。
ERROR_NOT_FOUND
資格情報が見つかりませんでした。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// credui.dll
#include <windows.h>

DWORD CredUIReadSSOCredW(
    LPCWSTR pszRealm,   // optional
    LPWSTR* ppszUsername
);
[DllImport("credui.dll", ExactSpelling = true)]
static extern uint CredUIReadSSOCredW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszRealm,   // LPCWSTR optional
    IntPtr ppszUsername   // LPWSTR* out
);
<DllImport("credui.dll", ExactSpelling:=True)>
Public Shared Function CredUIReadSSOCredW(
    <MarshalAs(UnmanagedType.LPWStr)> pszRealm As String,   ' LPCWSTR optional
    ppszUsername As IntPtr   ' LPWSTR* out
) As UInteger
End Function
' pszRealm : LPCWSTR optional
' ppszUsername : LPWSTR* out
Declare PtrSafe Function CredUIReadSSOCredW Lib "credui" ( _
    ByVal pszRealm As LongPtr, _
    ByVal ppszUsername As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CredUIReadSSOCredW = ctypes.windll.credui.CredUIReadSSOCredW
CredUIReadSSOCredW.restype = wintypes.DWORD
CredUIReadSSOCredW.argtypes = [
    wintypes.LPCWSTR,  # pszRealm : LPCWSTR optional
    ctypes.c_void_p,  # ppszUsername : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('credui.dll')
CredUIReadSSOCredW = Fiddle::Function.new(
  lib['CredUIReadSSOCredW'],
  [
    Fiddle::TYPE_VOIDP,  # pszRealm : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ppszUsername : LPWSTR* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "credui")]
extern "system" {
    fn CredUIReadSSOCredW(
        pszRealm: *const u16,  // LPCWSTR optional
        ppszUsername: *mut *mut u16  // LPWSTR* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("credui.dll")]
public static extern uint CredUIReadSSOCredW([MarshalAs(UnmanagedType.LPWStr)] string pszRealm, IntPtr ppszUsername);
"@
$api = Add-Type -MemberDefinition $sig -Name 'credui_CredUIReadSSOCredW' -Namespace Win32 -PassThru
# $api::CredUIReadSSOCredW(pszRealm, ppszUsername)
#uselib "credui.dll"
#func global CredUIReadSSOCredW "CredUIReadSSOCredW" sptr, sptr
; CredUIReadSSOCredW pszRealm, varptr(ppszUsername)   ; 戻り値は stat
; pszRealm : LPCWSTR optional -> "sptr"
; ppszUsername : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "credui.dll"
#cfunc global CredUIReadSSOCredW "CredUIReadSSOCredW" wstr, var
; res = CredUIReadSSOCredW(pszRealm, ppszUsername)
; pszRealm : LPCWSTR optional -> "wstr"
; ppszUsername : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD CredUIReadSSOCredW(LPCWSTR pszRealm, LPWSTR* ppszUsername)
#uselib "credui.dll"
#cfunc global CredUIReadSSOCredW "CredUIReadSSOCredW" wstr, var
; res = CredUIReadSSOCredW(pszRealm, ppszUsername)
; pszRealm : LPCWSTR optional -> "wstr"
; ppszUsername : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	credui = windows.NewLazySystemDLL("credui.dll")
	procCredUIReadSSOCredW = credui.NewProc("CredUIReadSSOCredW")
)

// pszRealm (LPCWSTR optional), ppszUsername (LPWSTR* out)
r1, _, err := procCredUIReadSSOCredW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszRealm))),
	uintptr(ppszUsername),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function CredUIReadSSOCredW(
  pszRealm: PWideChar;   // LPCWSTR optional
  ppszUsername: PPWideChar   // LPWSTR* out
): DWORD; stdcall;
  external 'credui.dll' name 'CredUIReadSSOCredW';
result := DllCall("credui\CredUIReadSSOCredW"
    , "WStr", pszRealm   ; LPCWSTR optional
    , "Ptr", ppszUsername   ; LPWSTR* out
    , "UInt")   ; return: DWORD
●CredUIReadSSOCredW(pszRealm, ppszUsername) = DLL("credui.dll", "dword CredUIReadSSOCredW(char*, void*)")
# 呼び出し: CredUIReadSSOCredW(pszRealm, ppszUsername)
# pszRealm : LPCWSTR optional -> "char*"
# ppszUsername : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "credui" fn CredUIReadSSOCredW(
    pszRealm: [*c]const u16, // LPCWSTR optional
    ppszUsername: [*c][*c]u16 // LPWSTR* out
) callconv(std.os.windows.WINAPI) u32;
proc CredUIReadSSOCredW(
    pszRealm: WideCString,  # LPCWSTR optional
    ppszUsername: ptr WideCString  # LPWSTR* out
): uint32 {.importc: "CredUIReadSSOCredW", stdcall, dynlib: "credui.dll".}
pragma(lib, "credui");
extern(Windows)
uint CredUIReadSSOCredW(
    const(wchar)* pszRealm,   // LPCWSTR optional
    wchar** ppszUsername   // LPWSTR* out
);
ccall((:CredUIReadSSOCredW, "credui.dll"), stdcall, UInt32,
      (Cwstring, Ptr{Ptr{UInt16}}),
      pszRealm, ppszUsername)
# pszRealm : LPCWSTR optional -> Cwstring
# ppszUsername : LPWSTR* out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t CredUIReadSSOCredW(
    const uint16_t* pszRealm,
    uint16_t** ppszUsername);
]]
local credui = ffi.load("credui")
-- credui.CredUIReadSSOCredW(pszRealm, ppszUsername)
-- pszRealm : LPCWSTR optional
-- ppszUsername : LPWSTR* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('credui.dll');
const CredUIReadSSOCredW = lib.func('__stdcall', 'CredUIReadSSOCredW', 'uint32_t', ['str16', 'void *']);
// CredUIReadSSOCredW(pszRealm, ppszUsername)
// pszRealm : LPCWSTR optional -> 'str16'
// ppszUsername : LPWSTR* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("credui.dll", {
  CredUIReadSSOCredW: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.CredUIReadSSOCredW(pszRealm, ppszUsername)
// pszRealm : LPCWSTR optional -> "buffer"
// ppszUsername : LPWSTR* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t CredUIReadSSOCredW(
    const uint16_t* pszRealm,
    uint16_t** ppszUsername);
C, "credui.dll");
// $ffi->CredUIReadSSOCredW(pszRealm, ppszUsername);
// pszRealm : LPCWSTR optional
// ppszUsername : LPWSTR* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Credui extends StdCallLibrary {
    Credui INSTANCE = Native.load("credui", Credui.class);
    int CredUIReadSSOCredW(
        WString pszRealm,   // LPCWSTR optional
        PointerByReference ppszUsername   // LPWSTR* out
    );
}
@[Link("credui")]
lib Libcredui
  fun CredUIReadSSOCredW = CredUIReadSSOCredW(
    pszRealm : UInt16*,   # LPCWSTR optional
    ppszUsername : UInt16**   # LPWSTR* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CredUIReadSSOCredWNative = Uint32 Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>);
typedef CredUIReadSSOCredWDart = int Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>);
final CredUIReadSSOCredW = DynamicLibrary.open('credui.dll')
    .lookupFunction<CredUIReadSSOCredWNative, CredUIReadSSOCredWDart>('CredUIReadSSOCredW');
// pszRealm : LPCWSTR optional -> Pointer<Utf16>
// ppszUsername : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CredUIReadSSOCredW(
  pszRealm: PWideChar;   // LPCWSTR optional
  ppszUsername: PPWideChar   // LPWSTR* out
): DWORD; stdcall;
  external 'credui.dll' name 'CredUIReadSSOCredW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CredUIReadSSOCredW"
  c_CredUIReadSSOCredW :: CWString -> Ptr CWString -> IO Word32
-- pszRealm : LPCWSTR optional -> CWString
-- ppszUsername : LPWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let creduireadssocredw =
  foreign "CredUIReadSSOCredW"
    ((ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> returning uint32_t)
(* pszRealm : LPCWSTR optional -> (ptr uint16_t) *)
(* ppszUsername : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library credui (t "credui.dll"))
(cffi:use-foreign-library credui)

(cffi:defcfun ("CredUIReadSSOCredW" cred-uiread-ssocred-w :convention :stdcall) :uint32
  (psz-realm (:string :encoding :utf-16le))   ; LPCWSTR optional
  (ppsz-username :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CredUIReadSSOCredW = Win32::API::More->new('credui',
    'DWORD CredUIReadSSOCredW(LPCWSTR pszRealm, LPVOID ppszUsername)');
# my $ret = $CredUIReadSSOCredW->Call($pszRealm, $ppszUsername);
# pszRealm : LPCWSTR optional -> LPCWSTR
# ppszUsername : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目