Changeset 1543 for branches/eraser6/CodeReview/Eraser.Util/KernelApi.cs
- Timestamp:
- 1/18/2010 4:19:42 AM (3 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/eraser6/CodeReview/Eraser.Util/KernelApi.cs
r1530 r1543 335 335 return null; 336 336 } 337 338 /// <summary>339 /// Stores Kernel32.dll functions, structs and constants.340 /// </summary>341 internal static class NativeMethods342 {343 /// <summary>344 /// Closes an open object handle.345 /// </summary>346 /// <param name="hObject">A valid handle to an open object.</param>347 /// <returns>If the function succeeds, the return value is true. To get348 /// extended error information, call Marshal.GetLastWin32Error().349 ///350 /// If the application is running under a debugger, the function will throw351 /// an exception if it receives either a handle value that is not valid352 /// or a pseudo-handle value. This can happen if you close a handle twice,353 /// or if you call CloseHandle on a handle returned by the FindFirstFile354 /// function.</returns>355 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]356 [return: MarshalAs(UnmanagedType.Bool)]357 public static extern bool CloseHandle(IntPtr hObject);358 359 /// <summary>360 /// Deletes an existing file.361 /// </summary>362 /// <param name="lpFileName">The name of the file to be deleted.363 ///364 /// In the ANSI version of this function, the name is limited to MAX_PATH365 /// characters. To extend this limit to 32,767 wide characters, call366 /// the Unicode version of the function and prepend "\\?\" to the path.367 /// For more information, see Naming a File.</param>368 /// <returns>If the function succeeds, the return value is nonzero.369 ///370 /// If the function fails, the return value is zero (0). To get extended371 /// error information, call Marshal.GetLastWin32Error().</returns>372 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]373 [return: MarshalAs(UnmanagedType.Bool)]374 public static extern bool DeleteFile(string lpFileName);375 376 /// <summary>377 /// Retrieves a pseudo handle for the current process.378 /// </summary>379 /// <returns>A pseudo handle to the current process.</returns>380 /// <remarks>A pseudo handle is a special constant, currently (HANDLE)-1,381 /// that is interpreted as the current process handle. For compatibility382 /// with future operating systems, it is best to call GetCurrentProcess383 /// instead of hard-coding this constant value. The calling process can384 /// use a pseudo handle to specify its own process whenever a process385 /// handle is required. Pseudo handles are not inherited by child processes.386 ///387 /// This handle has the maximum possible access to the process object.388 /// For systems that support security descriptors, this is the maximum389 /// access allowed by the security descriptor for the calling process.390 /// For systems that do not support security descriptors, this is391 /// PROCESS_ALL_ACCESS. For more information, see Process Security and392 /// Access Rights.393 ///394 /// A process can create a "real" handle to itself that is valid in the395 /// context of other processes, or that can be inherited by other processes,396 /// by specifying the pseudo handle as the source handle in a call to the397 /// DuplicateHandle function. A process can also use the OpenProcess398 /// function to open a real handle to itself.399 ///400 /// The pseudo handle need not be closed when it is no longer needed.401 /// Calling the CloseHandle function with a pseudo handle has no effect.402 /// If the pseudo handle is duplicated by DuplicateHandle, the duplicate403 /// handle must be closed.</remarks>404 [DllImport("Kernel32.dll", SetLastError = true)]405 public static extern IntPtr GetCurrentProcess();406 407 /// <summary>408 /// Retrieves information about the current system.409 /// </summary>410 /// <param name="lpSystemInfo">A pointer to a SYSTEM_INFO structure that411 /// receives the information.</param>412 [DllImport("Kernel32.dll")]413 public static extern void GetSystemInfo(out SYSTEM_INFO lpSystemInfo);414 415 /// <summary>416 /// The QueryPerformanceCounter function retrieves the current value of417 /// the high-resolution performance counter.418 /// </summary>419 /// <param name="lpPerformanceCount">[out] Pointer to a variable that receives420 /// the current performance-counter value, in counts.</param>421 /// <returns>If the function succeeds, the return value is nonzero.422 ///423 /// If the function fails, the return value is zero. To get extended error424 /// information, call Marshal.GetLastWin32Error. </returns>425 [DllImport("Kernel32.dll", SetLastError = true)]426 [return: MarshalAs(UnmanagedType.Bool)]427 public static extern bool QueryPerformanceCounter(out long lpPerformanceCount);428 429 /// <summary>430 /// Contains information about the current computer system. This includes431 /// the architecture and type of the processor, the number of processors432 /// in the system, the page size, and other such information.433 /// </summary>434 [StructLayout(LayoutKind.Sequential)]435 internal struct SYSTEM_INFO436 {437 /// <summary>438 /// Represents a list of processor architectures.439 /// </summary>440 public enum ProcessorArchitecture : ushort441 {442 /// <summary>443 /// x64 (AMD or Intel).444 /// </summary>445 PROCESSOR_ARCHITECTURE_AMD64 = 9,446 447 /// <summary>448 /// Intel Itanium Processor Family (IPF).449 /// </summary>450 PROCESSOR_ARCHITECTURE_IA64 = 6,451 452 /// <summary>453 /// x86.454 /// </summary>455 PROCESSOR_ARCHITECTURE_INTEL = 0,456 457 /// <summary>458 /// Unknown architecture.459 /// </summary>460 PROCESSOR_ARCHITECTURE_UNKNOWN = 0xffff461 }462 463 /// <summary>464 /// The processor architecture of the installed operating system.465 /// This member can be one of the ProcessorArchitecture values.466 /// </summary>467 public ProcessorArchitecture processorArchitecture;468 469 /// <summary>470 /// This member is reserved for future use.471 /// </summary>472 private const ushort reserved = 0;473 474 /// <summary>475 /// The page size and the granularity of page protection and commitment.476 /// This is the page size used by the VirtualAlloc function.477 /// </summary>478 public uint pageSize;479 480 /// <summary>481 /// A pointer to the lowest memory address accessible to applications482 /// and dynamic-link libraries (DLLs).483 /// </summary>484 public IntPtr minimumApplicationAddress;485 486 /// <summary>487 /// A pointer to the highest memory address accessible to applications488 /// and DLLs.489 /// </summary>490 public IntPtr maximumApplicationAddress;491 492 /// <summary>493 /// A mask representing the set of processors configured into the system.494 /// Bit 0 is processor 0; bit 31 is processor 31.495 /// </summary>496 public IntPtr activeProcessorMask;497 498 /// <summary>499 /// The number of processors in the system.500 /// </summary>501 public uint numberOfProcessors;502 503 /// <summary>504 /// An obsolete member that is retained for compatibility. Use the505 /// wProcessorArchitecture, wProcessorLevel, and wProcessorRevision506 /// members to determine the type of processor.507 /// Name Value508 /// PROCESSOR_INTEL_386 386509 /// PROCESSOR_INTEL_486 486510 /// PROCESSOR_INTEL_PENTIUM 586511 /// PROCESSOR_INTEL_IA64 2200512 /// PROCESSOR_AMD_X8664 8664513 /// </summary>514 public uint processorType;515 516 /// <summary>517 /// The granularity for the starting address at which virtual memory518 /// can be allocated. For more information, see VirtualAlloc.519 /// </summary>520 public uint allocationGranularity;521 522 /// <summary>523 /// The architecture-dependent processor level. It should be used only524 /// for display purposes. To determine the feature set of a processor,525 /// use the IsProcessorFeaturePresent function.526 ///527 /// If wProcessorArchitecture is PROCESSOR_ARCHITECTURE_INTEL, wProcessorLevel528 /// is defined by the CPU vendor.529 /// If wProcessorArchitecture is PROCESSOR_ARCHITECTURE_IA64, wProcessorLevel530 /// is set to 1.531 /// </summary>532 public ushort processorLevel;533 534 /// <summary>535 /// The architecture-dependent processor revision. The following table536 /// shows how the revision value is assembled for each type of537 /// processor architecture.538 ///539 /// Processor Value540 /// Intel Pentium, Cyrix The high byte is the model and the541 /// or NextGen 586 low byte is the stepping. For example,542 /// if the value is xxyy, the model number543 /// and stepping can be displayed as follows:544 /// Model xx, Stepping yy545 /// Intel 80386 or 80486 A value of the form xxyz.546 /// If xx is equal to 0xFF, y - 0xA is the model547 /// number, and z is the stepping identifier.548 ///549 /// If xx is not equal to 0xFF, xx + 'A'550 /// is the stepping letter and yz is the minor stepping.551 /// </summary>552 public ushort processorRevision;553 }554 555 [DllImport("Kernel32.dll")]556 public static extern EXECUTION_STATE SetThreadExecutionState(EXECUTION_STATE esFlags);557 558 /// <summary>559 /// Execution state values to be used in conjuction with SetThreadExecutionState560 /// </summary>561 [Flags]562 public enum EXECUTION_STATE : uint563 {564 ES_AWAYMODE_REQUIRED = 0x00000040,565 ES_CONTINUOUS = 0x80000000,566 ES_DISPLAY_REQUIRED = 0x00000002,567 ES_SYSTEM_REQUIRED = 0x00000001,568 ES_USER_PRESENT = 0x00000004569 }570 571 [DllImport("Kernel32.dll", SetLastError = true)]572 [return: MarshalAs(UnmanagedType.Bool)]573 public static extern bool AllocConsole();574 575 [DllImport("Kernel32.dll", SetLastError = true)]576 [return: MarshalAs(UnmanagedType.Bool)]577 public static extern bool FreeConsole();578 579 /// <summary>580 /// The CreateFile function creates or opens a file, file stream, directory,581 /// physical disk, volume, console buffer, tape drive, communications resource,582 /// mailslot, or named pipe. The function returns a handle that can be used583 /// to access an object.584 /// </summary>585 /// <param name="FileName"></param>586 /// <param name="DesiredAccess"> access to the object, which can be read,587 /// write, or both</param>588 /// <param name="ShareMode">The sharing mode of an object, which can be589 /// read, write, both, or none</param>590 /// <param name="SecurityAttributes">A pointer to a SECURITY_ATTRIBUTES591 /// structure that determines whether or not the returned handle can be592 /// inherited by child processes. Can be null</param>593 /// <param name="CreationDisposition">An action to take on files that exist594 /// and do not exist</param>595 /// <param name="FlagsAndAttributes">The file attributes and flags.</param>596 /// <param name="hTemplateFile">A handle to a template file with the597 /// GENERIC_READ access right. The template file supplies file attributes598 /// and extended attributes for the file that is being created. This599 /// parameter can be null</param>600 /// <returns>If the function succeeds, the return value is an open handle601 /// to a specified file. If a specified file exists before the function602 /// all and dwCreationDisposition is CREATE_ALWAYS or OPEN_ALWAYS, a call603 /// to GetLastError returns ERROR_ALREADY_EXISTS, even when the function604 /// succeeds. If a file does not exist before the call, GetLastError605 /// returns 0.606 ///607 /// If the function fails, the return value is INVALID_HANDLE_VALUE.608 /// To get extended error information, call Marshal.GetLastWin32Error().</returns>609 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]610 public static extern SafeFileHandle CreateFile(string lpFileName, uint dwDesiredAccess,611 uint dwShareMode, IntPtr SecurityAttributes, uint dwCreationDisposition,612 uint dwFlagsAndAttributes, IntPtr hTemplateFile);613 614 public const uint GENERIC_READ = 0x80000000;615 public const uint GENERIC_WRITE = 0x40000000;616 public const uint GENERIC_EXECUTE = 0x20000000;617 public const uint GENERIC_ALL = 0x10000000;618 619 public const uint FILE_SHARE_READ = 0x00000001;620 public const uint FILE_SHARE_WRITE = 0x00000002;621 public const uint FILE_SHARE_DELETE = 0x00000004;622 623 public const uint CREATE_NEW = 1;624 public const uint CREATE_ALWAYS = 2;625 public const uint OPEN_EXISTING = 3;626 public const uint OPEN_ALWAYS = 4;627 public const uint TRUNCATE_EXISTING = 5;628 629 public const uint FILE_FLAG_WRITE_THROUGH = 0x80000000;630 public const uint FILE_FLAG_OVERLAPPED = 0x40000000;631 public const uint FILE_FLAG_NO_BUFFERING = 0x20000000;632 public const uint FILE_FLAG_RANDOM_ACCESS = 0x10000000;633 public const uint FILE_FLAG_SEQUENTIAL_SCAN = 0x08000000;634 public const uint FILE_FLAG_DELETE_ON_CLOSE = 0x04000000;635 public const uint FILE_FLAG_BACKUP_SEMANTICS = 0x02000000;636 public const uint FILE_FLAG_POSIX_SEMANTICS = 0x01000000;637 public const uint FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000;638 public const uint FILE_FLAG_OPEN_NO_RECALL = 0x00100000;639 public const uint FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000;640 641 [DllImport("Kernel32.dll", SetLastError = true)]642 [return: MarshalAs(UnmanagedType.Bool)]643 public extern static bool DeviceIoControl(SafeFileHandle hDevice,644 uint dwIoControlCode, IntPtr lpInBuffer, uint nInBufferSize,645 out ushort lpOutBuffer, uint nOutBufferSize, out uint lpBytesReturned,646 IntPtr lpOverlapped);647 648 [DllImport("Kernel32.dll", SetLastError = true)]649 [return: MarshalAs(UnmanagedType.Bool)]650 public extern static bool DeviceIoControl(SafeFileHandle hDevice,651 uint dwIoControlCode, ref ushort lpInBuffer, uint nInBufferSize,652 IntPtr lpOutBuffer, uint nOutBufferSize, out uint lpBytesReturned,653 IntPtr lpOverlapped);654 655 public const uint FSCTL_GET_COMPRESSION = 0x9003C;656 public const uint FSCTL_SET_COMPRESSION = 0x9C040;657 public const ushort COMPRESSION_FORMAT_NONE = 0x0000;658 public const ushort COMPRESSION_FORMAT_DEFAULT = 0x0001;659 660 [DllImport("Kernel32.dll", SetLastError = true)]661 [return: MarshalAs(UnmanagedType.Bool)]662 public extern static bool DeviceIoControl(SafeFileHandle hDevice,663 uint dwIoControlCode, IntPtr lpInBuffer, uint nInBufferSize,664 IntPtr lpOutBuffer, uint nOutBufferSize, out uint lpBytesReturned,665 IntPtr lpOverlapped);666 public const uint FSCTL_LOCK_VOLUME = 0x90018;667 public const uint FSCTL_UNLOCK_VOLUME = 0x9001C;668 669 [DllImport("Kernel32.dll", SetLastError = true)]670 [return: MarshalAs(UnmanagedType.Bool)]671 public extern static bool DeviceIoControl(SafeFileHandle hDevice,672 uint dwIoControlCode, IntPtr lpInBuffer, uint nInBufferSize,673 out DiskPerformanceInfoInternal lpOutBuffer, uint nOutBufferSize, out uint lpBytesReturned,674 IntPtr lpOverlapped);675 676 public const uint IOCTL_DISK_PERFORMANCE = ((0x00000007) << 16) | ((0x0008) << 2);677 678 public unsafe struct DiskPerformanceInfoInternal679 {680 public long BytesRead;681 public long BytesWritten;682 public long ReadTime;683 public long WriteTime;684 public long IdleTime;685 public uint ReadCount;686 public uint WriteCount;687 public uint QueueDepth;688 public uint SplitCount;689 public long QueryTime;690 public uint StorageDeviceNumber;691 public fixed short StorageManagerName[8];692 }693 694 /// <summary>695 /// Retrieves a set of FAT file system attributes for a specified file or696 /// directory.697 /// </summary>698 /// <param name="lpFileName">The name of the file or directory.</param>699 /// <returns>If the function succeeds, the return value contains the attributes700 /// of the specified file or directory.701 ///702 /// If the function fails, the return value is INVALID_FILE_ATTRIBUTES.703 /// To get extended error information, call Marshal.GetLastWin32Error.704 ///705 /// The attributes can be one or more of the FILE_ATTRIBUTE_* values.</returns>706 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]707 public static extern uint GetFileAttributes(string lpFileName);708 709 /// <summary>710 /// Sets the attributes for a file or directory.711 /// </summary>712 /// <param name="lpFileName">The name of the file whose attributes are713 /// to be set.</param>714 /// <param name="dwFileAttributes">The file attributes to set for the file.715 /// This parameter can be one or more of the FILE_ATTRIBUTE_* values.716 /// However, all other values override FILE_ATTRIBUTE_NORMAL.</param>717 /// <returns>If the function succeeds, the return value is nonzero.718 ///719 /// If the function fails, the return value is zero. To get extended error720 /// information, call Marshal.GetLastWin32Error.</returns>721 [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2205:UseManagedEquivalentsOfWin32Api")]722 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]723 [return: MarshalAs(UnmanagedType.Bool)]724 public static extern bool SetFileAttributes(string lpFileName,725 uint dwFileAttributes);726 727 /// <summary>728 /// Retrieves the size of the specified file.729 /// </summary>730 /// <param name="hFile">A handle to the file. The handle must have been731 /// created with either the GENERIC_READ or GENERIC_WRITE access right.732 /// For more information, see File Security and Access Rights.</param>733 /// <param name="lpFileSize">A reference to a long that receives the file734 /// size, in bytes.</param>735 /// <returns>If the function succeeds, the return value is nonzero.736 ///737 /// If the function fails, the return value is zero. To get extended error738 /// information, call Marshal.GetLastWin32Error.</returns>739 [DllImport("Kernel32.dll", SetLastError = true)]740 [return: MarshalAs(UnmanagedType.Bool)]741 public static extern bool GetFileSizeEx(SafeFileHandle hFile, out long lpFileSize);742 743 /// <summary>744 /// Retrieves the date and time that a file or directory was created, last745 /// accessed, and last modified.746 /// </summary>747 /// <param name="hFile">A handle to the file or directory for which dates748 /// and times are to be retrieved. The handle must have been created using749 /// the CreateFile function with the GENERIC_READ access right. For more750 /// information, see File Security and Access Rights.</param>751 /// <param name="lpCreationTime">A pointer to a FILETIME structure to752 /// receive the date and time the file or directory was created. This753 /// parameter can be NULL if the application does not require this754 /// information.</param>755 /// <param name="lpLastAccessTime">A pointer to a FILETIME structure to756 /// receive the date and time the file or directory was last accessed. The757 /// last access time includes the last time the file or directory was758 /// written to, read from, or, in the case of executable files, run. This759 /// parameter can be NULL if the application does not require this760 /// information.</param>761 /// <param name="lpLastWriteTime">A pointer to a FILETIME structure to762 /// receive the date and time the file or directory was last written to,763 /// truncated, or overwritten (for example, with WriteFile or SetEndOfFile).764 /// This date and time is not updated when file attributes or security765 /// descriptors are changed. This parameter can be NULL if the application766 /// does not require this information.</param>767 /// <returns>If the function succeeds, the return value is nonzero.768 ///769 /// If the function fails, the return value is zero. To get extended error770 /// information, call Marshal.GetLastWin32Error().</returns>771 [DllImport("Kernel32.dll", SetLastError = true)]772 [return: MarshalAs(UnmanagedType.Bool)]773 public static extern bool GetFileTime(SafeFileHandle hFile,774 out System.Runtime.InteropServices.ComTypes.FILETIME lpCreationTime,775 out System.Runtime.InteropServices.ComTypes.FILETIME lpLastAccessTime,776 out System.Runtime.InteropServices.ComTypes.FILETIME lpLastWriteTime);777 778 /// <summary>779 /// Sets the date and time that the specified file or directory was created,780 /// last accessed, or last modified.781 /// </summary>782 /// <param name="hFile">A handle to the file or directory. The handle must783 /// have been created using the CreateFile function with the784 /// FILE_WRITE_ATTRIBUTES access right. For more information, see File785 /// Security and Access Rights.</param>786 /// <param name="lpCreationTime">A pointer to a FILETIME structure that787 /// contains the new creation date and time for the file or directory.788 /// This parameter can be NULL if the application does not need to change789 /// this information.</param>790 /// <param name="lpLastAccessTime">A pointer to a FILETIME structure that791 /// contains the new last access date and time for the file or directory.792 /// The last access time includes the last time the file or directory was793 /// written to, read from, or (in the case of executable files) run. This794 /// parameter can be NULL if the application does not need to change this795 /// information.796 ///797 /// To preserve the existing last access time for a file even after accessing798 /// a file, call SetFileTime immediately after opening the file handle799 /// with this parameter's FILETIME structure members initialized to800 /// 0xFFFFFFFF.</param>801 /// <param name="lpLastWriteTime">A pointer to a FILETIME structure that802 /// contains the new last modified date and time for the file or directory.803 /// This parameter can be NULL if the application does not need to change804 /// this information.</param>805 /// <returns>If the function succeeds, the return value is nonzero.806 ///807 /// If the function fails, the return value is zero. To get extended error808 /// information, call GetLastError.</returns>809 [DllImport("Kernel32.dll", SetLastError = true)]810 [return: MarshalAs(UnmanagedType.Bool)]811 public static extern bool SetFileTime(SafeFileHandle hFile,812 ref System.Runtime.InteropServices.ComTypes.FILETIME lpCreationTime,813 ref System.Runtime.InteropServices.ComTypes.FILETIME lpLastAccessTime,814 ref System.Runtime.InteropServices.ComTypes.FILETIME lpLastWriteTime);815 816 /// <summary>817 /// Retrieves the name of a volume on a computer. FindFirstVolume is used818 /// to begin scanning the volumes of a computer.819 /// </summary>820 /// <param name="lpszVolumeName">A pointer to a buffer that receives a821 /// null-terminated string that specifies the unique volume name of the822 /// first volume found.</param>823 /// <param name="cchBufferLength">The length of the buffer to receive the824 /// name, in TCHARs.</param>825 /// <returns>If the function succeeds, the return value is a search handle826 /// used in a subsequent call to the FindNextVolume and FindVolumeClose827 /// functions.828 ///829 /// If the function fails to find any volumes, the return value is the830 /// INVALID_HANDLE_VALUE error code. To get extended error information,831 /// call GetLastError.</returns>832 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]833 public static extern SafeFileHandle FindFirstVolume(StringBuilder lpszVolumeName,834 uint cchBufferLength);835 836 /// <summary>837 /// Continues a volume search started by a call to the FindFirstVolume838 /// function. FindNextVolume finds one volume per call.839 /// </summary>840 /// <param name="hFindVolume">The volume search handle returned by a previous841 /// call to the FindFirstVolume function.</param>842 /// <param name="lpszVolumeName">A pointer to a string that receives the843 /// unique volume name found.</param>844 /// <param name="cchBufferLength">The length of the buffer that receives845 /// the name, in TCHARs.</param>846 /// <returns>If the function succeeds, the return value is nonzero.847 ///848 /// If the function fails, the return value is zero. To get extended error849 /// information, call GetLastError. If no matching files can be found, the850 /// GetLastError function returns the ERROR_NO_MORE_FILES error code. In851 /// that case, close the search with the FindVolumeClose function.</returns>852 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]853 [return: MarshalAs(UnmanagedType.Bool)]854 public static extern bool FindNextVolume(SafeHandle hFindVolume,855 StringBuilder lpszVolumeName, uint cchBufferLength);856 857 /// <summary>858 /// Closes the specified volume search handle. The FindFirstVolume and859 /// FindNextVolume functions use this search handle to locate volumes.860 /// </summary>861 /// <param name="hFindVolume">The volume search handle to be closed. This862 /// handle must have been previously opened by the FindFirstVolume function.</param>863 /// <returns>If the function succeeds, the return value is nonzero.864 ///865 /// If the function fails, the return value is zero. To get extended error866 /// information, call GetLastError.</returns>867 [DllImport("Kernel32.dll", SetLastError = true)]868 [return: MarshalAs(UnmanagedType.Bool)]869 public static extern bool FindVolumeClose(SafeHandle hFindVolume);870 871 /// <summary>872 /// Retrieves the name of a volume mount point on the specified volume.873 /// FindFirstVolumeMountPoint is used to begin scanning the volume mount874 /// points on a volume.875 /// </summary>876 /// <param name="lpszRootPathName">The unique volume name of the volume877 /// to scan for volume mount points. A trailing backslash is required.</param>878 /// <param name="lpszVolumeMountPoint">A pointer to a buffer that receives879 /// the name of the first volume mount point found.</param>880 /// <param name="cchBufferLength">The length of the buffer that receives881 /// the volume mount point name, in TCHARs.</param>882 /// <returns>If the function succeeds, the return value is a search handle883 /// used in a subsequent call to the FindNextVolumeMountPoint and884 /// FindVolumeMountPointClose functions.885 ///886 /// If the function fails to find a volume mount point on the volume, the887 /// return value is the INVALID_HANDLE_VALUE error code. To get extended888 /// error information, call GetLastError.</returns>889 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]890 public static extern SafeFileHandle FindFirstVolumeMountPoint(891 string lpszRootPathName, StringBuilder lpszVolumeMountPoint,892 uint cchBufferLength);893 894 /// <summary>895 /// Continues a volume mount point search started by a call to the896 /// FindFirstVolumeMountPoint function. FindNextVolumeMountPoint finds one897 /// volume mount point per call.898 /// </summary>899 /// <param name="hFindVolumeMountPoint">A mount-point search handle returned900 /// by a previous call to the FindFirstVolumeMountPoint function.</param>901 /// <param name="lpszVolumeMountPoint">A pointer to a buffer that receives902 /// the name of the volume mount point found.</param>903 /// <param name="cchBufferLength">The length of the buffer that receives904 /// the names, in TCHARs.</param>905 /// <returns>If the function succeeds, the return value is nonzero.906 ///907 /// If the function fails, the return value is zero. To get extended error908 /// information, call GetLastError. If no matching files can be found, the909 /// GetLastError function returns the ERROR_NO_MORE_FILES error code. In910 /// that case, close the search with the FindVolumeMountPointClose function.</returns>911 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]912 [return: MarshalAs(UnmanagedType.Bool)]913 public static extern bool FindNextVolumeMountPoint(914 SafeHandle hFindVolumeMountPoint, StringBuilder lpszVolumeMountPoint,915 uint cchBufferLength);916 917 /// <summary>918 /// Closes the specified mount-point search handle. The FindFirstVolumeMountPoint919 /// and FindNextVolumeMountPoint functions use this search handle to locate920 /// volume mount points on a specified volume.921 /// </summary>922 /// <param name="hFindVolumeMountPoint">The mount-point search handle to923 /// be closed. This handle must have been previously opened by the924 /// FindFirstVolumeMountPoint function.</param>925 /// <returns>If the function succeeds, the return value is nonzero.926 ///927 /// If the function fails, the return value is zero. To get extended error928 /// information, call GetLastError.</returns>929 [DllImport("Kernel32.dll", SetLastError = true)]930 [return: MarshalAs(UnmanagedType.Bool)]931 public static extern bool FindVolumeMountPointClose(SafeHandle hFindVolumeMountPoint);932 933 /// <summary>934 /// Retrieves information about the specified disk, including the amount935 /// of free space on the disk.936 ///937 /// The GetDiskFreeSpace function cannot report volume sizes that are938 /// greater than 2 gigabytes (GB). To ensure that your application works939 /// with large capacity hard drives, use the GetDiskFreeSpaceEx function.940 /// </summary>941 /// <param name="lpRootPathName">The root directory of the disk for which942 /// information is to be returned. If this parameter is NULL, the function943 /// uses the root of the current disk. If this parameter is a UNC name,944 /// it must include a trailing backslash (for example, \\MyServer\MyShare\).945 /// Furthermore, a drive specification must have a trailing backslash946 /// (for example, C:\). The calling application must have FILE_LIST_DIRECTORY947 /// access rights for this directory.</param>948 /// <param name="lpSectorsPerCluster">A pointer to a variable that receives949 /// the number of sectors per cluster.</param>950 /// <param name="lpBytesPerSector">A pointer to a variable that receives951 /// the number of bytes per sector.</param>952 /// <param name="lpNumberOfFreeClusters">A pointer to a variable that953 /// receives the total number of free clusters on the disk that are954 /// available to the user who is associated with the calling thread.955 ///956 /// If per-user disk quotas are in use, this value may be less than the957 /// total number of free clusters on the disk.</param>958 /// <param name="lpTotalNumberOfClusters">A pointer to a variable that959 /// receives the total number of clusters on the disk that are available960 /// to the user who is associated with the calling thread.961 ///962 /// If per-user disk quotas are in use, this value may be less than the963 /// total number of clusters on the disk.</param>964 /// <returns>If the function succeeds, the return value is true. To get965 /// extended error information, call Marshal.GetLastWin32Error().</returns>966 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]967 [return: MarshalAs(UnmanagedType.Bool)]968 public static extern bool GetDiskFreeSpace(969 string lpRootPathName, out UInt32 lpSectorsPerCluster, out UInt32 lpBytesPerSector,970 out UInt32 lpNumberOfFreeClusters, out UInt32 lpTotalNumberOfClusters);971 972 973 /// <summary>974 /// Retrieves information about the amount of space that is available on975 /// a disk volume, which is the total amount of space, the total amount976 /// of free space, and the total amount of free space available to the977 /// user that is associated with the calling thread.978 /// </summary>979 /// <param name="lpDirectoryName">A directory on the disk.980 ///981 /// If this parameter is NULL, the function uses the root of the current982 /// disk.983 ///984 /// If this parameter is a UNC name, it must include a trailing backslash,985 /// for example, "\\MyServer\MyShare\".986 ///987 /// This parameter does not have to specify the root directory on a disk.988 /// The function accepts any directory on a disk.989 ///990 /// The calling application must have FILE_LIST_DIRECTORY access rights991 /// for this directory.</param>992 /// <param name="lpFreeBytesAvailable">A pointer to a variable that receives993 /// the total number of free bytes on a disk that are available to the994 /// user who is associated with the calling thread.995 ///996 /// This parameter can be NULL.997 ///998 /// If per-user quotas are being used, this value may be less than the999 /// total number of free bytes on a disk.</param>1000 /// <param name="lpTotalNumberOfBytes">A pointer to a variable that receives1001 /// the total number of bytes on a disk that are available to the user who1002 /// is associated with the calling thread.1003 ///1004 /// This parameter can be NULL.1005 ///1006 /// If per-user quotas are being used, this value may be less than the1007 /// total number of bytes on a disk.1008 ///1009 /// To determine the total number of bytes on a disk or volume, use1010 /// IOCTL_DISK_GET_LENGTH_INFO.</param>1011 /// <param name="lpTotalNumberOfFreeBytes">A pointer to a variable that1012 /// receives the total number of free bytes on a disk.1013 ///1014 /// This parameter can be NULL.</param>1015 /// <returns>If the function succeeds, the return value is nonzero.1016 ///1017 /// If the function fails, the return value is zero (0). To get extended1018 /// error information, call GetLastError.</returns>1019 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]1020 [return: MarshalAs(UnmanagedType.Bool)]1021 public static extern bool GetDiskFreeSpaceEx(1022 string lpDirectoryName,1023 out UInt64 lpFreeBytesAvailable,1024 out UInt64 lpTotalNumberOfBytes,1025 out UInt64 lpTotalNumberOfFreeBytes);1026 1027 /// <summary>1028 /// Determines whether a disk drive is a removable, fixed, CD-ROM, RAM disk,1029 /// or network drive.1030 /// </summary>1031 /// <param name="lpRootPathName">The root directory for the drive.1032 ///1033 /// A trailing backslash is required. If this parameter is NULL, the function1034 /// uses the root of the current directory.</param>1035 /// <returns>The return value specifies the type of drive, which can be1036 /// one of the DriveInfo.DriveType values.</returns>1037 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]1038 public static extern uint GetDriveType(string lpRootPathName);1039 1040 /// <summary>1041 /// Retrieves information about the file system and volume associated with1042 /// the specified root directory.1043 ///1044 /// To specify a handle when retrieving this information, use the1045 /// GetVolumeInformationByHandleW function.1046 ///1047 /// To retrieve the current compression state of a file or directory, use1048 /// FSCTL_GET_COMPRESSION.1049 /// </summary>1050 /// <param name="lpRootPathName"> A pointer to a string that contains1051 /// the root directory of the volume to be described.1052 ///1053 /// If this parameter is NULL, the root of the current directory is used.1054 /// A trailing backslash is required. For example, you specify1055 /// \\MyServer\MyShare as "\\MyServer\MyShare\", or the C drive as "C:\".</param>1056 /// <param name="lpVolumeNameBuffer">A pointer to a buffer that receives1057 /// the name of a specified volume. The maximum buffer size is MAX_PATH+1.</param>1058 /// <param name="nVolumeNameSize">The length of a volume name buffer, in1059 /// TCHARs. The maximum buffer size is MAX_PATH+1.1060 ///1061 /// This parameter is ignored if the volume name buffer is not supplied.</param>1062 /// <param name="lpVolumeSerialNumber">A pointer to a variable that receives1063 /// the volume serial number.1064 ///1065 /// This parameter can be NULL if the serial number is not required.1066 ///1067 /// This function returns the volume serial number that the operating system1068 /// assigns when a hard disk is formatted. To programmatically obtain the1069 /// hard disk's serial number that the manufacturer assigns, use the1070 /// Windows Management Instrumentation (WMI) Win32_PhysicalMedia property1071 /// SerialNumber.</param>1072 /// <param name="lpMaximumComponentLength">A pointer to a variable that1073 /// receives the maximum length, in TCHARs, of a file name component that1074 /// a specified file system supports.1075 ///1076 /// A file name component is the portion of a file name between backslashes.1077 ///1078 /// The value that is stored in the variable that *lpMaximumComponentLength1079 /// points to is used to indicate that a specified file system supports1080 /// long names. For example, for a FAT file system that supports long names,1081 /// the function stores the value 255, rather than the previous 8.3 indicator.1082 /// Long names can also be supported on systems that use the NTFS file system.</param>1083 /// <param name="lpFileSystemFlags">A pointer to a variable that receives1084 /// flags associated with the specified file system.1085 ///1086 /// This parameter can be one or more of the FS_FILE* flags. However,1087 /// FS_FILE_COMPRESSION and FS_VOL_IS_COMPRESSED are mutually exclusive.</param>1088 /// <param name="lpFileSystemNameBuffer">A pointer to a buffer that receives1089 /// the name of the file system, for example, the FAT file system or the1090 /// NTFS file system. The maximum buffer size is MAX_PATH+1.</param>1091 /// <param name="nFileSystemNameSize">The length of the file system name1092 /// buffer, in TCHARs. The maximum buffer size is MAX_PATH+1.1093 ///1094 /// This parameter is ignored if the file system name buffer is not supplied.</param>1095 /// <returns>If all the requested information is retrieved, the return value1096 /// is nonzero.1097 ///1098 ///1099 /// If not all the requested information is retrieved, the return value is1100 /// zero (0). To get extended error information, call GetLastError.</returns>1101 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]1102 [return: MarshalAs(UnmanagedType.Bool)]1103 public static extern bool GetVolumeInformation(1104 string lpRootPathName,1105 StringBuilder lpVolumeNameBuffer,1106 uint nVolumeNameSize,1107 out uint lpVolumeSerialNumber,1108 out uint lpMaximumComponentLength,1109 out uint lpFileSystemFlags,1110 StringBuilder lpFileSystemNameBuffer,1111 uint nFileSystemNameSize);1112 1113 /// <summary>1114 /// Retrieves the unique volume name for the specified volume mount point or root directory.1115 /// </summary>1116 /// <param name="lpszVolumeMountPoint">The path of a volume mount point (with a trailing1117 /// backslash, "\") or a drive letter indicating a root directory (in the1118 /// form "D:\").</param>1119 /// <param name="lpszVolumeName">A pointer to a string that receives the1120 /// volume name. This name is a unique volume name of the form1121 /// "\\?\Volume{GUID}\" where GUID is the GUID that identifies the volume.</param>1122 /// <param name="cchBufferLength">The length of the output buffer, in TCHARs.1123 /// A reasonable size for the buffer to accommodate the largest possible1124 /// volume name is 50 characters.</param>1125 /// <returns>If the function succeeds, the return value is nonzero.1126 ///1127 /// If the function fails, the return value is zero. To get extended1128 /// error information, call GetLastError.</returns>1129 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]1130 [return: MarshalAs(UnmanagedType.Bool)]1131 public static extern bool GetVolumeNameForVolumeMountPoint(1132 string lpszVolumeMountPoint, StringBuilder lpszVolumeName,1133 uint cchBufferLength);1134 1135 /// <summary>1136 /// Retrieves a list of path names for the specified volume name.1137 /// </summary>1138 /// <param name="lpszVolumeName">The volume name.</param>1139 /// <param name="lpszVolumePathNames">A pointer to a buffer that receives1140 /// the list of volume path names. The list is an array of null-terminated1141 /// strings terminated by an additional NULL character. If the buffer is1142 /// not large enough to hold the complete list, the buffer holds as much1143 /// of the list as possible.</param>1144 /// <param name="cchBufferLength">The length of the lpszVolumePathNames1145 /// buffer, in TCHARs.</param>1146 /// <param name="lpcchReturnLength">If the call is successful, this parameter1147 /// is the number of TCHARs copied to the lpszVolumePathNames buffer. Otherwise,1148 /// this parameter is the size of the buffer required to hold the complete1149 /// list, in TCHARs.</param>1150 /// <returns></returns>1151 [DllImport("Kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]1152 [return: MarshalAs(UnmanagedType.Bool)]1153 public static extern bool GetVolumePathNamesForVolumeName(1154 string lpszVolumeName, StringBuilder lpszVolumePathNames, uint cchBufferLength,1155 out uint lpcchReturnLength);1156 1157 public const int MaxPath = 260;1158 public const int LongPath = 32768;1159 }1160 337 } 1161 338 … … 1178 355 /// not supported. 1179 356 /// </summary> 1180 AwayModeRequired = (int) KernelApi.NativeMethods.EXECUTION_STATE.ES_AWAYMODE_REQUIRED,357 AwayModeRequired = (int)NativeMethods.EXECUTION_STATE.ES_AWAYMODE_REQUIRED, 1181 358 1182 359 /// <summary> … … 1185 362 /// state flags is cleared. 1186 363 /// </summary> 1187 Continuous = unchecked((int) KernelApi.NativeMethods.EXECUTION_STATE.ES_CONTINUOUS),364 Continuous = unchecked((int)NativeMethods.EXECUTION_STATE.ES_CONTINUOUS), 1188 365 1189 366 /// <summary> 1190 367 /// Forces the display to be on by resetting the display idle timer. 1191 368 /// </summary> 1192 DisplayRequired = (int) KernelApi.NativeMethods.EXECUTION_STATE.ES_DISPLAY_REQUIRED,369 DisplayRequired = (int)NativeMethods.EXECUTION_STATE.ES_DISPLAY_REQUIRED, 1193 370 1194 371 /// <summary> … … 1196 373 /// idle timer. 1197 374 /// </summary> 1198 SystemRequired = (int) KernelApi.NativeMethods.EXECUTION_STATE.ES_SYSTEM_REQUIRED,375 SystemRequired = (int)NativeMethods.EXECUTION_STATE.ES_SYSTEM_REQUIRED, 1199 376 1200 377 /// <summary> … … 1207 384 /// ES_USER_PRESENT must be called with ES_CONTINUOUS. 1208 385 /// </summary> 1209 UserPresent = (int) KernelApi.NativeMethods.EXECUTION_STATE.ES_USER_PRESENT386 UserPresent = (int)NativeMethods.EXECUTION_STATE.ES_USER_PRESENT 1210 387 } 1211 388 }
Note: See TracChangeset
for help on using the changeset viewer.