ホーム › Data.RightsManagement › DRMGetUserInfo

DRMGetUserInfo

関数

RMSユーザーの名前やIDなどの情報を取得する。

DLLmsdrm.dll呼出規約winapi

シグネチャ

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

HRESULT DRMGetUserInfo(
    DWORD hUser,
    DWORD* puUserNameLength,
    LPWSTR wszUserName,   // optional
    DWORD* puUserIdLength,
    LPWSTR wszUserId,   // optional
    DWORD* puUserIdTypeLength,
    LPWSTR wszUserIdType   // optional
);

パラメーター

名前	型	方向	説明
hUser	DWORD	in	情報を取得する対象のユーザーのハンドル。
puUserNameLength	DWORD*	inout	UINT 値へのポインター。呼び出し時には、wszUserName バッファーの長さ (文字数) を格納します。この長さには終端の null 文字を含める必要があります。関数から制御が戻ると、この値には wszUserName バッファーにコピーされた文字数 (終端の null 文字を含む) が格納されます。
wszUserName	LPWSTR	outoptional	null で終わる Unicode 文字列へのポインター。完全修飾された SMTP 電子メールアドレスの形式でユーザー名を受け取ります。これは強制されるものではなく、ID の確認に使用されるものでもありません。人間が読める識別情報を提供する目的でのみ含まれています。このバッファーのサイズは puUserNameLength パラメーターで指定します。このバッファーに必要なサイズを調べるには、このパラメーターに NULL を渡します。関数は、終端の null 文字を含む文字数単位のサイズを puUserNameLength の値に格納します。
puUserIdLength	DWORD*	inout	UINT 値へのポインター。呼び出し時には、wszUserId バッファーの長さ (文字数) を格納します。この長さには終端の null 文字を含める必要があります。関数から制御が戻ると、この値には wszUserId バッファーにコピーされた文字数 (終端の null 文字を含む) が格納されます。
wszUserId	LPWSTR	outoptional	null で終わる Unicode 文字列へのポインター。ユーザーの ID を受け取ります。このバッファーのサイズは puUserIdLength パラメーターで指定します。このバッファーに必要なサイズを調べるには、このパラメーターに NULL を渡します。関数は、終端の null 文字を含む文字数単位のサイズを puUserIdLength の値に格納します。
puUserIdTypeLength	DWORD*	inout	UINT 値へのポインター。呼び出し時には、wszUserIdType バッファーの長さ (文字数) を格納します。この長さには終端の null 文字を含める必要があります。関数から制御が戻ると、この値には wszUserIdType バッファーにコピーされた文字数 (終端の null 文字を含む) が格納されます。
wszUserIdType	LPWSTR	outoptional	null で終わる Unicode 文字列へのポインター。ユーザーの識別に使用される ID の種類 (Passport、Windows、その他など) を受け取ります。このバッファーのサイズは puUserIdTypeLength パラメーターで指定します。このバッファーに必要なサイズを調べるには、このパラメーターに NULL を渡します。関数は、終端の null 文字を含む文字数単位のサイズを puUserIdTypeLength の値に格納します。

戻り値の型: HRESULT

公式ドキュメント

ユーザーに関する情報を取得します。

戻り値

関数が成功した場合は、S_OK を返します。

関数が失敗した場合は、エラーを示す HRESULT 値を返します。返される可能性のある値には、次の一覧の値が含まれますが、これらに限定されません。一般的なエラーコードの一覧については、Common HRESULT Values を参照してください。

解説(Remarks)

ユーザー ID および ID の種類の詳細については、DRMCreateUser を参照してください。

出力値を取得する際は、まず wszUserName、wszUserId、wszUserIdType に NULL を設定してこの関数を呼び出し、puUserNameLength、puUserIdLength、puUserIdTypeLength を通じて必要なバッファーサイズを取得できます。バッファー領域の割り当てと解放は、アプリケーションが行う必要があります。

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

各言語での呼び出し定義

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

HRESULT DRMGetUserInfo(
    DWORD hUser,
    DWORD* puUserNameLength,
    LPWSTR wszUserName,   // optional
    DWORD* puUserIdLength,
    LPWSTR wszUserId,   // optional
    DWORD* puUserIdTypeLength,
    LPWSTR wszUserIdType   // optional
);

[DllImport("msdrm.dll", ExactSpelling = true)]
static extern int DRMGetUserInfo(
    uint hUser,   // DWORD
    ref uint puUserNameLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder wszUserName,   // LPWSTR optional, out
    ref uint puUserIdLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder wszUserId,   // LPWSTR optional, out
    ref uint puUserIdTypeLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder wszUserIdType   // LPWSTR optional, out
);

<DllImport("msdrm.dll", ExactSpelling:=True)>
Public Shared Function DRMGetUserInfo(
    hUser As UInteger,   ' DWORD
    ByRef puUserNameLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> wszUserName As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef puUserIdLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> wszUserId As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef puUserIdTypeLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> wszUserIdType As System.Text.StringBuilder   ' LPWSTR optional, out
) As Integer
End Function

' hUser : DWORD
' puUserNameLength : DWORD* in/out
' wszUserName : LPWSTR optional, out
' puUserIdLength : DWORD* in/out
' wszUserId : LPWSTR optional, out
' puUserIdTypeLength : DWORD* in/out
' wszUserIdType : LPWSTR optional, out
Declare PtrSafe Function DRMGetUserInfo Lib "msdrm" ( _
    ByVal hUser As Long, _
    ByRef puUserNameLength As Long, _
    ByVal wszUserName As LongPtr, _
    ByRef puUserIdLength As Long, _
    ByVal wszUserId As LongPtr, _
    ByRef puUserIdTypeLength As Long, _
    ByVal wszUserIdType As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DRMGetUserInfo = ctypes.windll.msdrm.DRMGetUserInfo
DRMGetUserInfo.restype = ctypes.c_int
DRMGetUserInfo.argtypes = [
    wintypes.DWORD,  # hUser : DWORD
    ctypes.POINTER(wintypes.DWORD),  # puUserNameLength : DWORD* in/out
    wintypes.LPWSTR,  # wszUserName : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # puUserIdLength : DWORD* in/out
    wintypes.LPWSTR,  # wszUserId : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # puUserIdTypeLength : DWORD* in/out
    wintypes.LPWSTR,  # wszUserIdType : LPWSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msdrm.dll')
DRMGetUserInfo = Fiddle::Function.new(
  lib['DRMGetUserInfo'],
  [
    -Fiddle::TYPE_INT,  # hUser : DWORD
    Fiddle::TYPE_VOIDP,  # puUserNameLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # wszUserName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # puUserIdLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # wszUserId : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # puUserIdTypeLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # wszUserIdType : LPWSTR optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "msdrm")]
extern "system" {
    fn DRMGetUserInfo(
        hUser: u32,  // DWORD
        puUserNameLength: *mut u32,  // DWORD* in/out
        wszUserName: *mut u16,  // LPWSTR optional, out
        puUserIdLength: *mut u32,  // DWORD* in/out
        wszUserId: *mut u16,  // LPWSTR optional, out
        puUserIdTypeLength: *mut u32,  // DWORD* in/out
        wszUserIdType: *mut u16  // LPWSTR optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msdrm.dll")]
public static extern int DRMGetUserInfo(uint hUser, ref uint puUserNameLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder wszUserName, ref uint puUserIdLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder wszUserId, ref uint puUserIdTypeLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder wszUserIdType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msdrm_DRMGetUserInfo' -Namespace Win32 -PassThru
# $api::DRMGetUserInfo(hUser, puUserNameLength, wszUserName, puUserIdLength, wszUserId, puUserIdTypeLength, wszUserIdType)

#uselib "msdrm.dll"
#func global DRMGetUserInfo "DRMGetUserInfo" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DRMGetUserInfo hUser, varptr(puUserNameLength), varptr(wszUserName), varptr(puUserIdLength), varptr(wszUserId), varptr(puUserIdTypeLength), varptr(wszUserIdType)   ; 戻り値は stat
; hUser : DWORD -> "sptr"
; puUserNameLength : DWORD* in/out -> "sptr"
; wszUserName : LPWSTR optional, out -> "sptr"
; puUserIdLength : DWORD* in/out -> "sptr"
; wszUserId : LPWSTR optional, out -> "sptr"
; puUserIdTypeLength : DWORD* in/out -> "sptr"
; wszUserIdType : LPWSTR optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msdrm.dll"
#cfunc global DRMGetUserInfo "DRMGetUserInfo" int, var, var, var, var, var, var
; res = DRMGetUserInfo(hUser, puUserNameLength, wszUserName, puUserIdLength, wszUserId, puUserIdTypeLength, wszUserIdType)
; hUser : DWORD -> "int"
; puUserNameLength : DWORD* in/out -> "var"
; wszUserName : LPWSTR optional, out -> "var"
; puUserIdLength : DWORD* in/out -> "var"
; wszUserId : LPWSTR optional, out -> "var"
; puUserIdTypeLength : DWORD* in/out -> "var"
; wszUserIdType : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msdrm.dll"
#cfunc global DRMGetUserInfo "DRMGetUserInfo" int, sptr, sptr, sptr, sptr, sptr, sptr
; res = DRMGetUserInfo(hUser, varptr(puUserNameLength), varptr(wszUserName), varptr(puUserIdLength), varptr(wszUserId), varptr(puUserIdTypeLength), varptr(wszUserIdType))
; hUser : DWORD -> "int"
; puUserNameLength : DWORD* in/out -> "sptr"
; wszUserName : LPWSTR optional, out -> "sptr"
; puUserIdLength : DWORD* in/out -> "sptr"
; wszUserId : LPWSTR optional, out -> "sptr"
; puUserIdTypeLength : DWORD* in/out -> "sptr"
; wszUserIdType : LPWSTR optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。