GetVolumeInformationW 関数 (fileapi.h)

指定したルート ディレクトリに関連付けられているファイル システムとボリュームに関する情報を取得します。

この情報を取得するときにハンドルを指定するには、 GetVolumeInformationByHandleW 関数を使用します。

ファイルまたはディレクトリの現在の圧縮状態を取得するには、 FSCTL_GET_COMPRESSIONを使用します。

構文

BOOL GetVolumeInformationW(
  [in, optional]  LPCWSTR lpRootPathName,
  [out, optional] LPWSTR  lpVolumeNameBuffer,
  [in]            DWORD   nVolumeNameSize,
  [out, optional] LPDWORD lpVolumeSerialNumber,
  [out, optional] LPDWORD lpMaximumComponentLength,
  [out, optional] LPDWORD lpFileSystemFlags,
  [out, optional] LPWSTR  lpFileSystemNameBuffer,
  [in]            DWORD   nFileSystemNameSize
);

パラメーター

[in, optional] lpRootPathName

記述するボリュームのルート ディレクトリを含む文字列へのポインター。

このパラメーターが NULL の場合は、現在のディレクトリのルートが使用されます。 末尾の円記号が必要です。 たとえば、\\MyServer\MyShare を "\\MyServer\MyShare\" として指定するか、C ドライブを "C:\" と指定します。

[out, optional] lpVolumeNameBuffer

指定したボリュームの名前を受け取るバッファーへのポインター。 バッファー サイズは 、nVolumeNameSize パラメーターで指定します。

[in] nVolumeNameSize

TCHAR でのボリューム名バッファーの長さ。 最大バッファー サイズは MAX_PATH+1 です。

ボリューム名バッファーが指定されていない場合、このパラメーターは無視されます。

[out, optional] lpVolumeSerialNumber

ボリュームのシリアル番号を受け取る変数へのポインター。

シリアル番号が不要な場合、このパラメーターは NULL にすることができます 。

この関数は、ハード ディスクのフォーマット時にオペレーティング システムによって割り当てられるボリュームのシリアル番号を返します。 製造元が割り当てるハード ディスクのシリアル番号をプログラムで取得するには、Windows Management Instrumentation (WMI) Win32_PhysicalMedia プロパティ SerialNumber を使用します。

[out, optional] lpMaximumComponentLength

指定したファイル システムがサポートするファイル名コンポーネントの最大長 (TCHAR) を受け取る変数へのポインター。

ファイル名コンポーネントは、円記号の間のファイル名の部分です。

*lpMaximumComponentLength が指す変数に格納されている値は、指定されたファイル システムが長い名前をサポートしていることを示すために使用されます。 たとえば、長い名前をサポートする FAT ファイル システムの場合、関数は前の 8.3 インジケーターではなく値 255 を格納します。 NTFS ファイル システムを使用するシステムでも、長い名前をサポートできます。

[out, optional] lpFileSystemFlags

指定したファイル システムに関連付けられているフラグを受け取る変数へのポインター。

このパラメーターには、次のフラグの 1 つ以上を指定できます。 ただし、 FILE_FILE_COMPRESSION と FILE_VOL_IS_COMPRESSED は相互に排他的です。

[out, optional] lpFileSystemNameBuffer

ファイル システムの名前 (FAT ファイル システムや NTFS ファイル システムなど) を受け取るバッファーへのポインター。 バッファー サイズは、 nFileSystemNameSize パラメーターで指定します。

[in] nFileSystemNameSize

TCHAR でのファイル システム名バッファーの長さ。 最大バッファー サイズは MAX_PATH+1 です。

ファイル システム名バッファーが指定されていない場合、このパラメーターは無視されます。

戻り値

要求されたすべての情報が取得された場合、戻り値は 0 以外です。

要求されたすべての情報が取得されない場合、戻り値は 0 です。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

ユーザーがフロッピー ディスクを持たないフロッピー ドライブ、またはコンパクト ディスクを持たない CD-ROM ドライブに関する情報を取得しようとすると、フロッピー ディスクまたはコンパクト ディスクをそれぞれ挿入するためのメッセージ ボックスが表示されます。 システムでこのメッセージ ボックスが表示されないようにするには、 setErrorMode 関数を SEM_FAILCRITICALERRORSと共に呼び出します。

FILE_VOL_IS_COMPRESSED フラグは、ボリューム ベースの圧縮の唯一のインジケーターです。 ファイル システム名は、圧縮を示すために変更されません。たとえば、このフラグは DoubleSpace ボリュームに設定されて返されます。 圧縮がボリュームベースの場合、ボリューム全体が圧縮されるか、圧縮されません。

FILE_FILE_COMPRESSION フラグは、ファイル システムがファイル ベースの圧縮をサポートしているかどうかを示します。 圧縮がファイルベースの場合、個々のファイルを圧縮するか、圧縮することはできません。

FILE_FILE_COMPRESSIONフラグとFILE_VOL_IS_COMPRESSED フラグは相互に排他的です。 両方のビットを設定して返すことはできません。

lpMaximumComponentLength に格納されるコンポーネントの最大長の値は、ボリュームが通常より長い FAT ファイル システム (またはその他のファイル システム) ファイル名をサポートしていることを示す唯一のインジケーターです。 ファイル システム名は、長いファイル名のサポートを示すために変更されません。

GetCompressedFileSize 関数は、ファイルの圧縮サイズを取得します。 GetFileAttributes 関数は、個々のファイルが圧縮されているかどうかを判断できます。

シンボリック リンクの動作

パスがシンボリック リンクを指している場合、関数はターゲットのボリューム情報を返します。

Windows 8とWindows Server 2012以降、この関数は次のテクノロジでサポートされています。

SMB では、ボリューム管理機能はサポートされていません。

トランザクション操作

ボリュームがファイル システム トランザクションをサポートしている場合、この関数は lpFileSystemFlags でFILE_SUPPORTS_TRANSACTIONSを返します。

要件

関連項目

KTM について

ファイルの暗号化

GetCompressedFileSize

GetFileAttributes

GetVolumeInformationByHandleW

SetErrorMode

SetVolumeLabel

ボリューム管理機能