Module win32api
A module, encapsulating the Windows Win32 API.
Methods
- AbortSystemShutdown
- Aborts a system shutdown
- InitiateSystemShutdown
- Initiates a shutdown and optional restart of the specified computer.
- Apply
- Calls a Python function, but traps Win32 exceptions.
- Beep
- Generates a simple tone on the speaker.
- BeginUpdateResource
- Begins an update cycle for a PE file.
- ChangeDisplaySettings
- Changes video mode for default display
- ChangeDisplaySettingsEx
- Changes video mode for specified display
- ClipCursor
- Confines the cursor to a rectangular area on the screen.
- CloseHandle
- Closes an open handle.
- CopyFile
- Copy a file.
- DebugBreak
- Breaks into the C debugger.
- DeleteFile
- Deletes the specified file.
- DragQueryFile
- Retrieve the file names for dropped files.
- DragFinish
- Free memory associated with dropped files.
- DuplicateHandle
- Duplicates a handle.
- EndUpdateResource
- Ends a resource update cycle of a PE file.
- EnumDisplayDevices
- Obtain information about the display devices in a system
- EnumDisplayMonitors
- Lists monitors for a device context
- EnumDisplaySettings
- Lists available modes for specified device
- EnumDisplaySettingsEx
- Lists available modes for a display device, with optional flags
- EnumResourceLanguages
- List languages for specified resource
- EnumResourceNames
- Enumerates all the resources of the specified type from the nominated file.
- EnumResourceTypes
- Return list of all resource types contained in module
- ExpandEnvironmentStrings
- Expands environment-variable strings and replaces them with their defined values.
- ExitWindows
- Logs off the current user
- ExitWindowsEx
- either logs off the current user, shuts down the system, or shuts down and restarts the system.
- FindFiles
- Find files matching a file spec.
- FindFirstChangeNotification
- Creates a change notification handle and sets up initial change notification filter conditions.
- FindNextChangeNotification
- Requests that the operating system signal a change notification handle the next time it detects an appropriate change.
- FindCloseChangeNotification
- Closes the change notification handle.
- FindExecutable
- Find an executable associated with a document.
- FormatMessage
- Return an error message string.
- FormatMessageW
- Return an error message string (as a Unicode object).
- FreeLibrary
- Decrements the reference count of the loaded dynamic-link library (DLL) module.
- GenerateConsoleCtrlEvent
- Send a specified signal to a console process group that shares the console associated with the calling process.
- GetAsyncKeyState
- Retrieves the asynch state of a virtual key code.
- GetCommandLine
- Return the application's command line.
- GetComputerName
- Returns the local computer name
- GetComputerNameEx
- Retrieves a NetBIOS or DNS name associated with the local computer
- GetComputerObjectName
- Retrieves the local computer's name in a specified format
- GetMonitorInfo
- Retrieves information for a monitor by handle
- GetUserName
- Returns the current user name.
- GetUserNameEx
- Returns the current user name in format specified by Name* constants
- GetCursorPos
- Returns the position of the cursor, in screen co-ordinates.
- GetCurrentThread
- Returns a pseudohandle for the current thread.
- GetCurrentThreadId
- Returns the thread ID for the current thread.
- GetCurrentProcessId
- Returns the thread ID for the current thread.
- GetCurrentProcess
- Returns a pseudohandle for the current process.
- GetConsoleTitle
- Return the application's console title.
- GetDateFormat
- Formats a date as a date string for a specified locale.
- GetDiskFreeSpace
- Retrieves information about a disk.
- GetDiskFreeSpaceEx
- Retrieves information about a disk.
- GetDllDirectory
- Retrieves the DLL search path
- GetDomainName
- Returns the current domain name
- GetEnvironmentVariable
- Retrieves the value of an environment variable.
- GetEnvironmentVariableW
- Retrieves the value of an environment variable.
- GetFileAttributes
- Retrieves the attributes for the named file.
- GetFileVersionInfo
- Retrieves string version info
- GetFocus
- Retrieves the handle of the keyboard focus window associated with the thread that called the method.
- GetFullPathName
- Returns the full path of a (possibly relative) path
- GetHandleInformation
- Retrieves a handle's flags.
- GetKeyboardLayout
- Retrieves the active input locale identifier
- GetKeyboardLayoutList
- Returns a sequence of all locale ids in the system
- GetKeyboardLayoutName
- Retrieves the name of the active input locale identifier (formerly called the keyboard layout).
- GetKeyboardState
- Retrieves the status of the 256 virtual keys on the keyboard.
- GetKeyState
- Retrives the last known key state for a key.
- GetLastError
- Retrieves the last error code known by the system.
- GetLastInputInfo
- Returns time of last input event in tick count
- GetLocalTime
- Returns the current local time.
- GetLongPathName
- Converts the specified path to its long form.
- GetLongPathNameW
- Converts the specified path to its long form.
- GetLogicalDrives
- Returns a bitmask representing the currently available disk drives.
- GetLogicalDriveStrings
- Returns a list of strings for all the drives.
- GetModuleFileName
- Retrieves the filename of the specified module.
- GetModuleFileNameW
- Retrieves the unicode filename of the specified module.
- GetModuleHandle
- Returns the handle of an already loaded DLL.
- GetPwrCapabilities
- Retrieves system's power capabilities
- GetProfileSection
- Returns a list of entries in an INI file.
- GetProcAddress
- Returns the address of the specified exported dynamic-link library (DLL) function.
- GetProfileVal
- Returns a value from an INI file.
- GetShortPathName
- Returns the 8.3 version of a pathname.
- GetStdHandle
- Returns a handle for the standard input, standard output, or standard error device
- GetSysColor
- Returns the system colors.
- GetSystemDefaultLangID
- Retrieves the system default language identifier.
- GetSystemDefaultLCID
- Retrieves the system default locale identifier.
- GetSystemDirectory
- Returns the Windows system directory.
- GetSystemFileCacheSize
- Returns the amount of memory reserved for file cache
- SetSystemFileCacheSize
- Sets the amount of memory reserved for file cache
- GetSystemInfo
- Retrieves information about the current system.
- GetNativeSystemInfo
- Retrieves information about the current system for a Wow64 process.
- GetSystemMetrics
- Returns the specified system metrics.
- GetSystemTime
- Returns the current system time.
- GetTempFileName
- Creates a temporary file.
- GetTempPath
- Returns the path designated as holding temporary files.
- GetThreadLocale
- Returns the current thread's locale.
- GetTickCount
- Returns the milliseconds since windows started.
- GetTimeFormat
- Formats a time as a time string for a specified locale.
- GetTimeZoneInformation
- Returns the system time-zone information.
- GetVersion
- Returns Windows version information.
- GetVersionEx
- Returns Windows version information as a tuple.
- GetVolumeInformation
- Returns information about a volume and file system attached to the system.
- GetWindowsDirectory
- Returns the windows directory.
- GetWindowLong
- Retrieves a long value at the specified offset into the extra window memory of the given window.
- GetUserDefaultLangID
- Retrieves the user default language identifier.
- GetUserDefaultLCID
- Retrieves the user default locale identifier.
- GlobalMemoryStatus
- Returns systemwide memory usage
- GlobalMemoryStatusEx
- Returns physical and virtual memory usage
- keybd_event
- Simulate a keyboard event
- mouse_event
- Simulate a mouse event
- LoadCursor
- Loads a cursor.
- LoadKeyboardLayout
- Loads a new locale id
- LoadLibrary
- Loads the specified DLL, and returns the handle.
- LoadLibraryEx
- Loads the specified DLL, and returns the handle.
- LoadResource
- Finds and loads a resource from a PE file.
- LoadString
- Loads a string from a resource file.
- MapVirtualKeyEx
- Translates (maps) a virtual-key code into a scan code or character value, or translates a scan code into a virtual-key code.
- MessageBeep
- Plays a predefined waveform sound.
- MessageBox
- Display a message box.
- MonitorFromPoint
- Finds monitor that contains a point
- MonitorFromRect
- Finds monitor that has largest intersection with a rectangle
- MonitorFromWindow
- Finds monitor that contains a window
- MoveFile
- Moves or renames a file.
- MoveFileEx
- Moves or renames a file.
- OpenProcess
- Retrieves a handle to an existing process.
- OutputDebugString
- Writes output to the Windows debugger.
- PostMessage
- Post a message to a window.
- PostQuitMessage
- Posts a quit message.
- PostThreadMessage
- Post a message to a thread.
- RegCloseKey
- Closes a registry key.
- RegConnectRegistry
- Establishes a connection to a predefined registry handle on another computer.
- RegCopyTree
- Copies an entire registry key to another location
- RegCreateKey
- Creates the specified key, or opens the key if it already exists.
- RegCreateKeyEx
- Extended version of RegCreateKey
- RegDeleteKey
- Deletes the specified key.
- RegDeleteKeyEx
- Deletes a registry key from 32 or 64 bit registry view
- RegDeleteTree
- Recursively deletes a key's subkeys and values
- RegDeleteValue
- Removes a named value from the specified registry key.
- RegEnumKey
- Enumerates subkeys of the specified open registry key.
- RegEnumKeyEx
- Enumerates subkeys of the specified open registry key.
- RegEnumKeyExW
- Unicode version of RegEnumKeyEx
- RegEnumValue
- Enumerates values of the specified open registry key.
- RegFlushKey
- Writes all the attributes of the specified key to the registry.
- RegGetKeySecurity
- Retrieves the security on the specified registry key.
- RegLoadKey
- Creates a subkey under HKEY_USER or HKEY_LOCAL_MACHINE and stores registration information from a specified file into that subkey.
- RegOpenCurrentUser
- Opens HKEY_CURRENT_USER for impersonated user
- RegOpenKey
- Alias for win32api::RegOpenKeyEx
- RegOpenKeyEx
- Opens the specified key.
- RegOpenKeyTransacted
- Opens a registry key as part of a transaction.
- RegOverridePredefKey
- Redirects one of the predefined keys to different key.
- RegQueryValue
- Retrieves the value associated with the unnamed value for a specified key in the registry.
- RegQueryValueEx
- Retrieves the type and data for a specified value name associated with an open registry key.
- RegQueryInfoKey
- Returns information about the specified key.
- RegQueryInfoKeyW
- Returns information about an open registry key
- RegRestoreKey
- Restores a key and subkeys from a saved registry file
- RegSaveKey
- Saves the specified key, and all its subkeys to the specified file.
- RegSaveKeyEx
- Extended version of RegSaveKey
- RegSetKeySecurity
- Sets the security on the specified registry key.
- RegSetValue
- Associates a value with a specified key. Currently, only strings are supported.
- RegSetValueEx
- Stores data in the value field of an open registry key.
- RegUnLoadKey
- Unloads the specified registry key and its subkeys from the registry. The keys must have been loaded previously by a call to RegLoadKey.
- RegisterWindowMessage
- Given a string, return a system wide unique message ID.
- RegNotifyChangeKeyValue
- Watch for registry changes
- SearchPath
- Searches a path for a file.
- SendMessage
- Send a message to a window.
- SetConsoleCtrlHandler
- Adds or removes an application-defined HandlerRoutine function from the list of handler functions for the calling process.
- SetConsoleTitle
- Sets the title for the current console.
- SetCursorPos
- The SetCursorPos function moves the cursor to the specified screen coordinates.
- SetDllDirectory
- Modifies the application-specific DLL search path
- SetErrorMode
- Controls whether the system will handle the specified types of serious errors, or whether the process will handle them.
- SetFileAttributes
- Sets the named file's attributes.
- SetLastError
- Sets the last error code known for the current thread.
- SetSysColors
- Changes color of various window elements
- SetLocalTime
- Changes the system's local time.
- SetSystemTime
- Sets the system time.
- SetClassLong
- Replaces the specified 32-bit (long) value at the specified offset into the extra class memory for the window.
- SetClassWord
- Replaces the specified 32-bit (long) value at the specified offset into the extra class memory for the window.
- SetWindowWord
- SetCursor
- Set the cursor to the HCURSOR object.
- SetEnvironmentVariable
- Creates, deletes, or changes the value of an environment variable.
- SetEnvironmentVariable
- Creates, deletes, or changes the value of an environment variable.
- SetEnvironmentVariableW
- Creates, deletes, or changes the value of an environment variable.
- SetHandleInformation
- Sets a handles's flags
- SetStdHandle
- Sets a handle for the standard input, standard output, or standard error device
- SetSystemPowerState
- Powers machine down to a suspended state
- SetThreadLocale
- Sets the current thread's locale.
- SetTimeZoneInformation
- Sets the system time-zone information.
- SetWindowLong
- Places a long value at the specified offset into the extra window memory of the given window.
- ShellExecute
- Executes an application.
- ShowCursor
- The ShowCursor method displays or hides the cursor.
- Sleep
- Suspends current application execution
- TerminateProcess
- Terminates a process.
- ToAsciiEx
- Translates the specified virtual-key code and keyboard state to the corresponding character or characters.
- Unicode
- Creates a new PyUnicode object
- UpdateResource
- Updates a resource in a PE file.
- VkKeyScan
- Translates a character to the corresponding virtual-key code and shift state.
- VkKeyScan
- Translates a character to the corresponding virtual-key code and shift state.
- WinExec
- Execute a program.
- WinHelp
- Invokes the Windows Help engine.
- WriteProfileSection
- Writes a complete section to an INI file or registry.
- WriteProfileVal
- Write a value to a Windows INI file.
- HIBYTE
- An interface to the win32api HIBYTE macro.
- LOBYTE
- An interface to the win32api LOBYTE macro.
- HIWORD
- An interface to the win32api HIWORD macro.
- LOWORD
- An interface to the win32api LOWORD macro.
- RGB
- An interface to the win32api RGB macro.
- MAKELANGID
- Creates a language identifier from a primary language identifier and a sublanguage identifier.
- MAKEWORD
- creates a WORD value by concatenating the specified values.
- MAKELONG
- creates a LONG value by concatenating the specified values.