RegLoadMUIStringA 関数 (winreg.h)

  • [アーティクル]

指定したキーとサブキーから指定した文字列を読み込みます。

構文

LSTATUS RegLoadMUIStringA(
  [in]            HKEY    hKey,
  [in, optional]  LPCSTR  pszValue,
  [out, optional] LPSTR   pszOutBuf,
  [in]            DWORD   cbOutBuf,
  [out, optional] LPDWORD pcbData,
  [in]            DWORD   Flags,
  [in, optional]  LPCSTR  pszDirectory
);

パラメーター

[in] hKey

開いているレジストリ キーへのハンドル。 キーは、KEY_QUERY_VALUEアクセス権で開かれている必要があります。 詳細については、「 レジストリ キーのセキュリティとアクセス権」を参照してください。

このハンドルは、 RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。 また、次の 定義済みキーのいずれかを指定することもできます。

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS

[in, optional] pszValue

レジストリ値の名前。

[out, optional] pszOutBuf

文字列を受け取るバッファーへのポインター。

次の形式の文字列は、特別な処理を受け取ります。

@[path]\dllname,-strID

識別子 strID を持つ文字列は dllname から読み込まれます。 パス は省略可能です。 pszDirectory パラメーターが NULL でない場合は、レジストリ データで指定されたパスの前にディレクトリが付加されます。 dllname には、展開する環境変数を含めることができます。

[in] cbOutBuf

pszOutBuf バッファーのサイズ (バイト単位)。

[out, optional] pcbData

pszOutBuf バッファーにコピーされたデータのサイズをバイト単位で受け取る変数へのポインター。

バッファーがデータを保持するのに十分な大きさでない場合、関数は ERROR_MORE_DATAを返し、必要なバッファー サイズを pcbData が指す変数に格納します。 この場合、バッファーの内容は未定義です。

[in] Flags

このパラメーターには、0 または次の値を指定できます。

値 意味
REG_MUI_STRING_TRUNCATE
0x00000001
 この文字列は、 pszOutBuf バッファーの使用可能なサイズに合わせて切り捨てられます。 このフラグを指定する場合、 pcbData は NULL である必要があります。

[in, optional] pszDirectory

ディレクトリのパスです。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は システム エラー コードです。

pcbData バッファーが小さすぎて文字列を受け取れなければ、関数は ERROR_MORE_DATAを返します。

この関数の ANSI バージョンは、ERROR_CALL_NOT_IMPLEMENTEDを返します。

注釈

RegLoadMUIString 関数は Unicode でのみサポートされています。 この関数の Unicode (W) バージョンと ANSI (A) バージョンの両方が宣言されていますが、 RegLoadMUIStringA 関数はERROR_CALL_NOT_IMPLEMENTEDを返します。 アプリケーションでは、 RegLoadMUIStringW を明示的に呼び出すか、プラットフォーム呼び出し (PInvoke) 呼び出しで文字セットとして Unicode を指定する必要があります。

この関数を使用するアプリケーションをコンパイルするには、0x0600 以降として_WIN32_WINNTを定義します。 詳細については、「 Windows ヘッダーの使用」を参照してください。

注意

winreg.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RegLoadMUIString を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winreg.h (Windows.h を含む)
Library Advapi32.lib
[DLL] Advapi32.dll

こちらもご覧ください

レジストリ関数