次の方法で共有

WritePrivateProfileStructW 関数 (winbase.h)

  • [アーティクル]

初期化ファイルの指定したセクションのキーにデータをコピーします。 データがコピーされると、関数はチェックサムを計算し、データの末尾に追加します。 GetPrivateProfileStruct 関数は、チェックサムを使用してデータの整合性を確保します。

注 この関数は、16 ビット バージョンの Windows との互換性のためにのみ提供されます。 アプリケーションは、レジストリに初期化情報を格納する必要があります。
 

構文

BOOL WritePrivateProfileStructW(
  [in] LPCWSTR lpszSection,
  [in] LPCWSTR lpszKey,
  [in] LPVOID  lpStruct,
  [in] UINT    uSizeStruct,
  [in] LPCWSTR szFile
);

パラメーター

[in] lpszSection

構造体データのコピー先となるセクションの名前。 セクションが存在しない場合は作成されます。 セクションの名前は大文字と小文字が区別されません。

[in] lpszKey

構造体に関連付けるキーの名前。 指定したセクションにキーが存在しない場合は、キーが作成されます。 このパラメーターが NULL場合、セクション内のすべてのキーとエントリを含むセクション全体が削除されます。

[in] lpStruct

コピーするデータ。 このパラメーターが NULL場合、キーは削除されます。

[in] uSizeStruct

lpStruct パラメーターが指すバッファーのサイズ (バイト単位)。

[in] szFile

初期化ファイルの名前。 このパラメーターが NULL場合、情報は Win.ini ファイルにコピーされます。

Unicode 文字を使用してファイルが作成された場合、この関数は Unicode 文字をファイルに書き込みます。 それ以外の場合、関数は ANSI 文字を書き込みます。

戻り値

関数が初期化ファイルに構造体を正常にコピーした場合、戻り値は 0 以外です。

関数が失敗した場合、または最近アクセスした初期化ファイルのキャッシュされたバージョンをフラッシュした場合、戻り値は 0 になります。 拡張エラー情報を取得するには、GetLastError呼び出します。

備考

初期化ファイルのセクションは、次の形式である必要があります。

[section]
key=struct

      .
      .
      .

szFile パラメーターにファイルの完全なパスとファイル名が含まれていない場合は、WritePrivateProfileString ファイルの Windows ディレクトリを検索します。 ファイルが存在しない場合、この関数は Windows ディレクトリにファイルを作成します。

szFile に完全なパスとファイル名が含まれており、ファイルが存在しない場合は、WriteProfileString によってファイルが作成されます。 指定したディレクトリが既に存在している必要があります。

システムは、パフォーマンスを向上させるために、最新のレジストリ ファイル マッピングのキャッシュされたバージョンを保持します。 すべてのパラメーターが NULL場合、関数はキャッシュをフラッシュします。 システムがキャッシュされたバージョンのファイルを編集している間、ファイル自体を編集するプロセスは、キャッシュがクリアされるまで元のファイルを使用します。

システムは、次のレジストリ キーで定義されたマッピングを使用して、ほとんどの .ini ファイル参照をレジストリにマップします。

HKEY_LOCAL_MACHINE
   SOFTWARE
      Microsoft
         Windows NT
            CurrentVersion
               IniFileMapping

このマッピングは、アプリケーションがシステム コンポーネントの初期化ファイル (Control.ini、System.ini、Winfile.iniなど) を変更する場合に発生する可能性があります。 この場合、関数は初期化ファイルではなくレジストリに情報を書き込みます。ストレージの場所の変更は、関数の動作には影響しません。

プロファイル関数では、次の手順を使用して初期化情報を検索します。

  1. IniFileMapping キーの下にある初期化ファイルの名前をレジストリで探します。
  2. lpAppNameで指定 セクション名を探します。 これは、初期化ファイルの名前を持つキーの下の名前付き値、またはこの名前のサブキーになります。または、名前が値またはサブキーとして存在しません。
  3. lpAppName で指定されたセクション名が名前付き値の場合、その値はレジストリ内のセクションのキーを検索する場所を指定します。
  4. lpAppName で指定されたセクション名がサブキーの場合、そのサブキーの下の名前付き値は、レジストリ内のどこにセクションのキーを見つけるかを指定します。 探しているキーが名前付き値として存在しない場合は、キーを検索するレジストリの既定の場所を指定する名前のない値 (<名前なし>と表示されます)。
  5. lpAppName で指定されたセクション名が名前付き値またはサブキーとして存在しない場合は、名前のない値 (<名前なし>として表示) があり、この値は、セクションのキーを検索するレジストリ内の既定の場所を指定します。
  6. セクション名のサブキーまたはエントリがない場合は、ディスク上の実際の初期化ファイルを探し、その内容を読み取ります。
他のレジストリの場所を指定するレジストリ内の値を見ると、.ini ファイル マッピングの動作を変更するプレフィックスがいくつかあります。
  • ! - この文字により、すべての書き込みがレジストリとディスク上の .ini ファイルの両方に強制的に移動します。
  • # - この文字により、新しいユーザーがセットアップ後に初めてログインしたときに、Windows 3.1 .ini ファイルの値にレジストリ値が設定されます。
  • @ - この文字は、要求されたデータがレジストリに見つからない場合に、ディスク上の .ini ファイルへの読み取りを禁止します。
  • USR: - このプレフィックスは HKEY_CURRENT_USERを表し、プレフィックスの後のテキストはそのキーに対して相対的です。
  • SYS: - このプレフィックスは HKEY_LOCAL_MACHINE\SOFTWAREを表し、プレフィックスの後のテキストはそのキーに対して相対的です。

手記

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

必要条件

要件 価値
サポートされる最小クライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされる最小サーバー Windows 2000 Server [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー winbase.h (Windows.h を含む)
ライブラリ Kernel32.lib
DLL Kernel32.dll

関連項目

GetPrivateProfileString の

WriteProfileString の