GetProfileType

関数

現在のユーザープロファイルの種類を取得する。

DLLUSERENV.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetProfileType(
    DWORD* dwFlags
);

パラメーター

名前	型	方向	説明
dwFlags	DWORD*	out	プロファイルの種類を受け取る変数へのポインター。関数が成功すると、次の値のうち 1 つ以上が設定されます。 PT_MANDATORY ユーザーは必須ユーザープロファイルを持っています。 PT_ROAMING ユーザーは移動ユーザープロファイルを持っています。 PT_ROAMING_PREEXISTING ユーザーは、別の PC で作成されてダウンロード中の移動ユーザープロファイルを持っています。このプロファイルの種類は PT_ROAMING を含意します。 PT_TEMPORARY ユーザーは一時ユーザープロファイルを持っています。これはログオフ時に削除されます。

名前

型

方向

説明

dwFlags

DWORD*

out

プロファイルの種類を受け取る変数へのポインター。関数が成功すると、次の値のうち 1 つ以上が設定されます。

PT_ROAMING_PREEXISTING

ユーザーは、別の PC で作成されてダウンロード中の移動ユーザープロファイルを持っています。このプロファイルの種類は PT_ROAMING を含意します。

PT_TEMPORARY

ユーザーは一時ユーザープロファイルを持っています。これはログオフ時に削除されます。

戻り値の型: BOOL

公式ドキュメント

現在のユーザーに対して読み込まれているプロファイルの種類を取得します。

戻り値

型: BOOL

成功した場合は TRUE、それ以外の場合は FALSE。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

ユーザープロファイルがまだ読み込まれていない場合、この関数は失敗します。

呼び出し元は HKEY_LOCAL_MACHINE に対する KEY_READ アクセス権を持っている必要があることに注意してください。このアクセス権は既定で付与されています。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。

プロファイルの種類が PT_ROAMING_PREEXISTING の場合、Explorer は、あるマシンで初めてプロファイルが読み込まれたときに既定のプログラム関連付けを再初期化しません。

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

各言語での呼び出し定義

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

BOOL GetProfileType(
    DWORD* dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetProfileType(
    out uint dwFlags   // DWORD* out
);

<DllImport("USERENV.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetProfileType(
    <Out> ByRef dwFlags As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : DWORD* out
Declare PtrSafe Function GetProfileType Lib "userenv" ( _
    ByRef dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetProfileType = ctypes.windll.userenv.GetProfileType
GetProfileType.restype = wintypes.BOOL
GetProfileType.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # dwFlags : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetProfileType = Fiddle::Function.new(
  lib['GetProfileType'],
  [
    Fiddle::TYPE_VOIDP,  # dwFlags : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "userenv")]
extern "system" {
    fn GetProfileType(
        dwFlags: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", SetLastError = true)]
public static extern bool GetProfileType(out uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetProfileType' -Namespace Win32 -PassThru
# $api::GetProfileType(dwFlags)

#uselib "USERENV.dll"
#func global GetProfileType "GetProfileType" sptr
; GetProfileType varptr(dwFlags)   ; 戻り値は stat
; dwFlags : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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