次の方法で共有

WritePrivateProfileStructA 関数 (winbase.h)

  • [アーティクル]

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

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

構文

BOOL WritePrivateProfileStructA(
  [in] LPCSTR lpszSection,
  [in] LPCSTR lpszKey,
  [in] LPVOID lpStruct,
  [in] UINT   uSizeStruct,
  [in] LPCSTR 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=string
      .
      .
      .

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

要件

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

関連項目

GetPrivateProfileString

WriteProfileString