os.windows.native_api

Module Contents

Classes

FileAttribute

list of file attributes constants.

Access

Desired Access constants.

Share

Share Access constants.

OpenOptions

File Open options.

Wait

Constants for WaitFor* functions.

Status

Error constants.

IOStatusBlock

Map IO_STATUS_BLOCK structure.

UnicodeString

Map UNICODE_STRING structure.

FileTime

Map FILETIME structure.

FileInfo

Declaration of structures returned by QueryInformationFile.

ObjectInfo

Declaration of structures returned by QueryObjectInformation.

ProcessInfo

Declaration of structure returned by QueryInformationProcess.

ObjectAttributes

OBJECT_ATTRIBUTES structure.

NT

Attributes

NTSTATUS

os.windows.native_api.NTSTATUS
class os.windows.native_api.FileAttribute

Bases: ctypes.Structure

list of file attributes constants.

READONLY = 1
HIDDEN = 2
SYSTEM = 4
DIRECTORY = 16
ARCHIVE = 32
DEVICE = 64
NORMAL = 128
TEMPORARY = 256
SPARSE_FILE = 512
REPARSE_POINT = 1024
COMPRESSED = 2048
OFFLINE = 4096
NOT_CONTENT_INDEXED = 8192
ENCRYPTED = 16384
INTEGRITY_STREAM = 32768
VIRTUAL = 65536
NO_SCRUB_DATA = 131072
_fields_ = [('attr',)]
__str__() str

Return str(self).

class os.windows.native_api.Access

Desired Access constants.

LIST_DIRECTORY = 1
READ_DATA = 1
ADD_FILE = 2
WRITE_DATA = 2
ADD_SUBDIR = 4
APPEND_DATA = 4
READ_EA = 8
WRITE_EA = 16
EXECUTE = 32
TRAVERSE = 32
DELETE_CHILD = 64
READ_ATTRS = 128
WRITE_ATTRS = 256
DELETE = 65536
SYNCHRONIZE = 1048576
PROCESS_QUERY_INFORMATION = 1024
class os.windows.native_api.Share

Share Access constants.

NOTHING = 0
READ = 1
WRITE = 2
DELETE = 4
ALL = 7
class os.windows.native_api.OpenOptions

File Open options.

BACKUP_INTENT = 16384
SYNCHRONOUS_IO_NON_ALERT = 32
DELETE_ON_CLOSE = 4096
class os.windows.native_api.Wait

Constants for WaitFor* functions.

OBJECT = 0
ABANDONED = 128
TIMEOUT = 258
FAILED = 4294967295
INFINITE = 4294967295
class os.windows.native_api.Status

Error constants.

ACCESS_DENIED = 3221225506
OBJECT_NAME_NOT_FOUND = 3221225524
OBJECT_PATH_NOT_FOUND = 3221225530
SHARING_VIOLATION = 3221225539
DELETE_PENDING = 3221225558
DIRECTORY_NOT_EMPTY = 3221225729
CANNOT_DELETE = 3221225761
NO_MORE_FILES = 2147483654
msgs
class os.windows.native_api.IOStatusBlock

Bases: ctypes.Structure

Map IO_STATUS_BLOCK structure.

_fields_ = [('status',), ('information',)]
class os.windows.native_api.UnicodeString(value: str | None = None, max_length: int = 0)

Bases: ctypes.Structure

Map UNICODE_STRING structure.

_fields_ = [('length',), ('maximum_length',), ('buffer',)]
__len__() int
class os.windows.native_api.FileTime(t: datetime.datetime)

Bases: ctypes.Structure

Map FILETIME structure.

property as_datetime: datetime.datetime
_fields_ = [('filetime',)]
__str__() str

Return str(self).

class os.windows.native_api.FileInfo

Declaration of structures returned by QueryInformationFile.

class Names
class_id = 12
class Disposition

Bases: ctypes.Structure

Structure base class

_fields_ = [('delete_file',)]
class_id = 13
class Internal

Bases: ctypes.Structure

Structure base class

_fields_ = [('index_number',)]
class_id = 6
class Rename

Bases: ctypes.Structure

Structure base class

_fields_: list = []
class_id = 10
class Basic

Bases: ctypes.Structure

Structure base class

_fields_ = [('creation_time',), ('last_access_time',), ('last_write_time',), ('change_time',), ('file_attributes',)]
class_id = 4
__str__() str

Return str(self).

class os.windows.native_api.ObjectInfo

Declaration of structures returned by QueryObjectInformation.

class Name

Bases: ctypes.Structure

Structure base class

_fields_: list = []
class_id = 1
class os.windows.native_api.ProcessInfo

Declaration of structure returned by QueryInformationProcess.

class Basic

Bases: ctypes.Structure

Structure base class

class_id = 0
_fields_ = [('exit_status',), ('peb',), ('affinity_mask',), ('base_priority',), ('pid',), ('ppid',)]
STILL_ACTIVE = 259
class os.windows.native_api.ObjectAttributes(name: UnicodeString, parent: ctypes.wintypes.HANDLE | None = None)

Bases: ctypes.Structure

OBJECT_ATTRIBUTES structure.

OBJ_CASE_INSENSITIVE = 64
_fields_ = [('length',), ('root_directory',), ('object_name',), ('attributes',), ('security_descriptor',),...
class os.windows.native_api.NT
Sleep
GetVolumePathName
SetInformationFile
QueryInformationFile
QueryAttributesFile
OpenFile
QueryDirectoryFile
Close
QueryInformationProcess
WaitForMultipleObjects
OpenProcess
QueryObject
classmethod init_api() None
exception os.windows.native_api.NTException(status: int, message: str, origin: str | None = None)

Bases: e3.error.E3Error

Exception raised by functions defined in E3.

__str__()

Return str(self).