Управляющий код FSCTL_GET_OBJECT_ID извлекает данные об идентификаторе объекта для заданного файла или каталога.
Чтобы выполнить эту операцию, вызовите функцию DeviceIoControl с ниже перечисленными параметрами.
Синтаксис
BOOL DeviceIoControl( (HANDLE) hDevice, // дескриптор устройства FSCTL_GET_OBJECT_ID, // dwIoControlCode NULL, // lpInBuffer 0, // nInBufferSize (LPVOID) lpOutBuffer, // буфер вывода данных (DWORD) nOutBufferSize, // размер буфера вывода данных (LPDWORD) lpBytesReturned, // число возвращаемых данных (LPOVERLAPPED) lpOverlapped // структура OVERLAPPED ); |
Параметры
hDevice
[in] Дескриптор файла или каталога из которого идентификатор объекта должен извлечься. Чтобы извлечь данные о дескрипторе устройства, вызовите функцию CreateFile.dwIoControlCode
[in] Управляющий код для операции. Используйте FSCTL_GET_OBJECT_ID для этой операции.lpInBuffer
Не используется с этой операцией; устанавливается в ПУСТО (NULL).
nInBufferSize
Не используется с этой операцией; устанавливается в нуль.
lpOutBuffer
[out] Указатель на буфер вывода данных, который - структура FILE_OBJECTID_BUFFER. Идентификатор объекта, связанный с параметром hDevice возвращается в этом буфере.nOutBufferSize
[in] Размер буфера вывода данных, в байтах.lpBytesReturned
[out] Указатель на переменную, которая получает размер данных, сохраненных в буфере вывода данных, в байтах.Если буфер вывода данных является слишком маленьким, вызов завершается ошибкой, а GetLastError возвращает значение ERROR_INSUFFICIENT_BUFFER, а lpBytesReturned равняется нулю.
Если lpOverlapped - ПУСТО (NULL), lpBytesReturned не может быть ПУСТО (NULL). Даже тогда, когда операция не возвращает никакого вывода данных, а lpOutBuffer - ПУСТО (NULL), DeviceIoControl использует lpBytesReturned. После такой операции, значение lpBytesReturned становится бессмысленным.
Если lpOverlapped - не ПУСТО (NULL), lpBytesReturned может быть ПУСТО (NULL). Если этот параметр - не ПУСТО (NULL), и операция возвращает данные, lpBytesReturned имеет значение не имеющего смысла до тех пор, пока асинхронная операция не завершиться. Чтобы извлечь информацию о числе возвращаемых данных, вызовите GetOverlappedResult. Если параметр hDevice связан с портом завершения ввода-вывода данных (I/O), Вы можете извлечь число возвращаемых данных при помощи вызова функции GetQueuedCompletionStatus.
lpOverlapped
[in] Указатель на структуру OVERLAPPED.Если параметр hDevice открывался без определения флажка FILE_FLAG_OVERLAPPED, параметр lpOverlapped игнорируется.
Если параметр hDevice открывался с флажком FILE_FLAG_OVERLAPPED, операция выполняется как перекрывающая (асинхронная) операция. В этой ситуации, параметр lpOverlapped должен указать на допустимую структуру OVERLAPPED, которая содержит дескриптор объекта события. В противном случае, функция завершается ошибкой непредсказуемыми способами.
Для асинхронных операций, DeviceIoControl возвращает значение немедленно, а объект события подает сигнал, когда операция завершается. В противном случае, функция не возвращает значение до тех пор, пока операция не завершится или не произойдет ошибка.
Возвращаемые значения
Если операция завершается успешно, DeviceIoControl возвращает ненулевое значение.
Если операция завершается ошибкой, DeviceIoControl возвращает нуль. Чтобы получить дополнительную информацию об ошибке, вызовите GetLastError.
Замечания
Идентификаторы объекта используются, чтобы отслеживать файлы и каталоги. Они невидимы в большинство приложений и никогда не должны модифицироваться приложениями. Изменение идентификатора объекта может привести к потере данных из частей файла, и далее, включая полностью тома данных.
Если нет идентификатора объекта, связанного с указанным дескриптором, ничего не создается и возвращается ошибка. Чтобы создать идентификатор объекта, используйте управляющий код FSCTL_SET_OBJECT_ID. Чтобы извлечь данные о существующем идентификаторе объекта или генерировать его, если нет существующего идентификатора объекта в первом шаге, используйте FSCTL_CREATE_OR_GET_OBJECT_ID.
Смотри также
Управляющие коды, используемые файловыми системами, Идентификаторы объекта, DeviceIoContro, CreateFile, FSCTL_CREATE_OR_GET_OBJECT_ID, FSCTL_DELETE_OBJECT_ID, FSCTL_SET_OBJECT_ID, FSCTL_SET_OBJECT_ID_EXTENDED
|
Размещение и совместимость FSCTL_GET_OBJECT_ID |
||
| К |
Windows XP |
Да |
| л |
Windows 2000 Professional |
Да |
| и |
Windows NT |
Нет |
| е |
Windows Me |
Нет |
| н |
Windows 98 |
Нет |
| т |
Windows 95 |
Нет |
| С |
Windows Server 2003 |
Да |
| е | Windows 2000 Server | Да |
| р | Windows NT Server | Нет |
| в | ||
| е | ||
| р | ||
|
Используемая библиотека |
- |
|
| Используемая DLL | - | |
| Заголовочный файл | ||
|
- объявлено в |
Winioctl.h |
|
| - включено в |
- |
|
| Unicode |
- |
|
| Замечания по платформе |
Не имеется |
|