WinAPI user defined functions Reference

Below is a complete list of the user defined functions available in AutoIt. Click on a user defined function name for a detailed description.

When using them you need to add a #include <WinAPI.au3>.

 

User Defined Function Description
_WinAPI_AttachConsole Attaches the calling process to the console of the specified process
_WinAPI_AttachThreadInput Attaches the input processing mechanism of one thread to that of another thread
_WinAPI_Beep Generates simple tones on the speaker
_WinAPI_BitBlt Performs a bit-block transfer of color data
_WinAPI_CallNextHookEx Passes the hook information to the next hook procedure in the current hook chain
_WinAPI_CallWindowProc Passes the hook information to the next hook procedure in the current hook chain
_WinAPI_ClientToScreen Converts the client coordinates of a specified point to screen coordinates
_WinAPI_CloseHandle Closes an open object handle
_WinAPI_CombineRgn Combines two regions and stores the result in a third region
_WinAPI_CommDlgExtendedError Returns a common dialog box error string. This string indicates the most recent error to occur during the execution of one of the common dialog box functions
_WinAPI_CopyIcon Copies the specified icon from another module
_WinAPI_CreateBitmap Creates a bitmap with the specified width, height, and color format
_WinAPI_CreateCompatibleBitmap Creates a bitmap compatible with the specified device context
_WinAPI_CreateCompatibleDC Creates a memory device context compatible with the specified device
_WinAPI_CreateEvent Creates or opens a named or unnamed event object
_WinAPI_CreateFile Creates or opens a file or other device
_WinAPI_CreateFont Creates a logical font with the specified characteristics
_WinAPI_CreateFontIndirect Creates a logical font that has specific characteristics
_WinAPI_CreatePen Creates a logical pen that has the specified style, width, and color
_WinAPI_CreateProcess Creates a new process and its primary thread
_WinAPI_CreateRectRgn Creates a rectangular region
_WinAPI_CreateRoundRectRgn Creates a rectangular region with rounded corners
_WinAPI_CreateSolidBitmap Creates a solid color bitmap
_WinAPI_CreateSolidBrush Creates a logical brush that has the specified solid color
_WinAPI_CreateWindowEx Creates an overlapped, pop-up, or child window
_WinAPI_DefWindowProc Call the default window procedure to provide default processing
_WinAPI_DeleteDC Deletes the specified device context
_WinAPI_DeleteObject Deletes a logical pen, brush, font, bitmap, region, or palette
_WinAPI_DestroyIcon Destroys an icon and frees any memory the icon occupied
_WinAPI_DestroyWindow Destroys the specified window
_WinAPI_DrawEdge Draws one or more edges of rectangle
_WinAPI_DrawFrameControl Draws a frame control of the specified type and style
_WinAPI_DrawIcon Draws an icon or cursor into the specified device context
_WinAPI_DrawIconEx Draws an icon or cursor into the specified device context
_WinAPI_DrawLine Draws a line
_WinAPI_DrawText Draws formatted text in the specified rectangle
_WinAPI_DuplicateHandle Duplicates an object handle
_WinAPI_EnableWindow Enables or disables mouse and keyboard input to the specified window or control
_WinAPI_EnumDisplayDevices Obtains information about the display devices in a system
_WinAPI_EnumWindows Enumerates all windows
_WinAPI_EnumWindowsPopup Enumerates popup windows
_WinAPI_EnumWindowsTop Enumerates all top level windows
_WinAPI_ExpandEnvironmentStrings Expands environment variable strings and replaces them with their defined values
_WinAPI_ExtractIconEx Creates an array of handles to large or small icons extracted from a file
_WinAPI_FatalAppExit Displays a message box and terminates the application
_WinAPI_FillRect Fills a rectangle by using the specified brush
_WinAPI_FindExecutable Retrieves the name of the executable file associated with the specified file name
_WinAPI_FindWindow Retrieves the handle to the top-level window whose class name and window name match
_WinAPI_FlashWindow Flashes the specified window one time
_WinAPI_FlashWindowEx Flashes the specified window
_WinAPI_FloatToInt Returns a 4 byte float as an integer value
_WinAPI_FlushFileBuffers Flushes the buffers of a specified file and causes all buffered data to be written
_WinAPI_FormatMessage Formats a message string
_WinAPI_FrameRect Draws a border around the specified rectangle by using the specified brush
_WinAPI_FreeLibrary Decrements the reference count of the loaded dynamic-link library (DLL) module
_WinAPI_GetAncestor Retrieves the handle to the ancestor of the specified window
_WinAPI_GetAsyncKeyState Determines whether a key is up or down at the time the function is called
_WinAPI_GetBkMode Returns the current background mix mode for a specified device context
_WinAPI_GetClassName Retrieves the name of the class to which the specified window belongs
_WinAPI_GetClientHeight Retrieves the height of a window's client area
_WinAPI_GetClientRect Retrieves the coordinates of a window's client area
_WinAPI_GetClientWidth Retrieves the width of a window's client area
_WinAPI_GetCurrentProcess Returns the process handle of the calling process
_WinAPI_GetCurrentProcessID Returns the process identifier of the calling process
_WinAPI_GetCurrentThread Retrieves a pseudo handle for the calling thread
_WinAPI_GetCurrentThreadId Returns the thread identifier of the calling thread
_WinAPI_GetCursorInfo Retrieves information about the global cursor
_WinAPI_GetDC Retrieves a handle of a display device context for the client area a window
_WinAPI_GetDesktopWindow Returns the handle of the Windows desktop window
_WinAPI_GetDeviceCaps Retrieves device specific information about a specified device
_WinAPI_GetDIBits Retrieves the bits of the specified bitmap and copies them into a buffer as a DIB
_WinAPI_GetDlgCtrlID Returns the identifier of the specified control
_WinAPI_GetDlgItem Retrieves the handle of a control in the specified dialog box
_WinAPI_GetFileSizeEx Retrieves the size of the specified file
_WinAPI_GetFocus Retrieves the handle of the window that has the keyboard focus
_WinAPI_GetForegroundWindow Returns the handle of the foreground window
_WinAPI_GetGuiResources Retrieves the count of handles to graphical user interface (GUI) objects in use by the specified process
_WinAPI_GetIconInfo Retrieves information about the specified icon or cursor
_WinAPI_GetLastError Returns the calling thread's lasterror code value
_WinAPI_GetLastErrorMessage Returns the calling threads last error message
_WinAPI_GetLayeredWindowAttributes Gets Layered Window Attributes
_WinAPI_GetModuleHandle Returns a module handle for the specified module
_WinAPI_GetMousePos Returns the current mouse position
_WinAPI_GetMousePosX Returns the current mouse X position
_WinAPI_GetMousePosY Returns the current mouse Y position
_WinAPI_GetObject Retrieves information for the specified graphics object
_WinAPI_GetOpenFileName Creates an Open dialog box that lets the user specify the drive, directory, and the name of a file or set of files to open
_WinAPI_GetOverlappedResult Retrieves the results of an overlapped operation
_WinAPI_GetParent Retrieves the handle of the specified child window's parent window
_WinAPI_GetProcAddress Retrieves the address of an exported function or variable from the specified module
_WinAPI_GetProcessAffinityMask Obtains the affinity masks for the process and the system
_WinAPI_GetSaveFileName Creates a Save dialog box that lets the user specify the drive, directory, and name of a file to save
_WinAPI_GetStdHandle Retrieves a handle for the standard input, standard output, or standard error device
_WinAPI_GetStockObject Retrieves a handle to one of the predefined stock pens, brushes, fonts, or palettes
_WinAPI_GetSysColor Retrieves the current color of the specified display element
_WinAPI_GetSysColorBrush Retrieves a handle identifying a logical brush that corresponds to the specified color index
_WinAPI_GetSystemMetrics Retrieves the specified system metric or system configuration setting
_WinAPI_GetTextExtentPoint32 Computes the width and height of the specified string of text
_WinAPI_GetTextMetrics Retrieves basic information for the currently selected font
_WinAPI_GetWindow Retrieves the handle of a window that has a specified relationship to the specified window
_WinAPI_GetWindowDC Retrieves the device context (DC) for the entire window
_WinAPI_GetWindowHeight Returns the height of the window
_WinAPI_GetWindowLong Retrieves information about the specified window
_WinAPI_GetWindowPlacement Retrieves the placement of the window for Min, Max, and normal positions
_WinAPI_GetWindowRect Retrieves the dimensions of the bounding rectangle of the specified window
_WinAPI_GetWindowRgn Obtains a copy of the window region of a window
_WinAPI_GetWindowText Retrieves the text of the specified window's title bar
_WinAPI_GetWindowThreadProcessId Retrieves the identifier of the thread that created the specified window
_WinAPI_GetWindowWidth Returns the width of the window
_WinAPI_GetXYFromPoint Returns the X/Y values from a $tagPOINT structure
_WinAPI_GlobalMemoryStatus Retrieves information about current available memory
_WinAPI_GUIDFromString Converts a string GUID to binary form
_WinAPI_GUIDFromStringEx Converts a string GUID to binary form
_WinAPI_HiWord Returns the high word of a longword value
_WinAPI_InProcess Determines whether a window belongs to the current process
_WinAPI_IntToFloat Returns a 4 byte integer as a float value
_WinAPI_InvalidateRect Adds a rectangle to the specified window's update region
_WinAPI_IsClassName Wrapper to check ClassName of the control
_WinAPI_IsWindow Determines whether the specified window handle identifies an existing window
_WinAPI_IsWindowVisible Retrieves the visibility state of the specified window
_WinAPI_LineTo Draws a line from the current position up to, but not including, the specified point
_WinAPI_LoadBitmap Loads the specified bitmap resource from a module's executable file
_WinAPI_LoadImage Loads an icon, cursor, or bitmap
_WinAPI_LoadLibrary Maps a specified executable module into the address space of the calling process
_WinAPI_LoadLibraryEx Maps a specified executable module into the address space of the calling process
_WinAPI_LoadShell32Icon Extracts an icon from the shell32.dll file
_WinAPI_LoadString loads a string resource from the executable file associated with a specified module
_WinAPI_LocalFree Frees the specified local memory object and invalidates its handle
_WinAPI_LoWord Returns the low word of a longword
_WinAPI_MAKELANGID Construct language id from a primary language id and a sublanguage id
_WinAPI_MAKELCID Construct locale id from a language id and a sort id
_WinAPI_MakeLong Returns a long int value from two int values
_WinAPI_MakeQWord Returns a QWORD value from two int values
_WinAPI_MessageBeep Plays a waveform sound
_WinAPI_Mouse_Event Synthesizes mouse motion and button clicks
_WinAPI_MoveTo Updates the current position to the specified point
_WinAPI_MoveWindow Changes the position and dimensions of the specified window
_WinAPI_MsgBox Displays a message box with wider margin than original
_WinAPI_MulDiv Multiplies two 32-bit values and then divides the 64-bit result by a third 32-bit value
_WinAPI_MultiByteToWideChar Maps a character string to a wide-character (Unicode) string
_WinAPI_MultiByteToWideCharEx Maps a character string to a wide-character (Unicode) string
_WinAPI_OpenProcess Returns a handle of an existing process object
_WinAPI_PathFindOnPath Searchs for a file in the default system paths
_WinAPI_PointFromRect Returns the top/left coordinates of a $tagRECT as a $tagPOINT structure
_WinAPI_PostMessage Places a message in the message queue and then returns
_WinAPI_PrimaryLangId Extract primary language id from a language id
_WinAPI_PtInRect Determines whether the specified point lies within the specified rectangle
_WinAPI_ReadFile Reads data from a file
_WinAPI_ReadProcessMemory Reads memory in a specified process
_WinAPI_RectIsEmpty Determins whether a rectangle is empty
_WinAPI_RedrawWindow Updates the specified rectangle or region in a window's client area
_WinAPI_RegisterWindowMessage Defines a new window message that is guaranteed to be unique throughout the system
_WinAPI_ReleaseCapture Releases the mouse capture from a window in the current thread and restores normal mouse input processing
_WinAPI_ReleaseDC Releases a device context
_WinAPI_ScreenToClient Converts screen coordinates of a specified point on the screen to client coordinates
_WinAPI_SelectObject Selects an object into the specified device context
_WinAPI_SetBkColor Sets the current background color to the specified color value
_WinAPI_SetBkMode Sets the background mix mode of the specified device context
_WinAPI_SetCapture Sets the mouse capture to the specified window belonging to the current thread
_WinAPI_SetCursor Establishes the cursor shape
_WinAPI_SetDefaultPrinter Sets the default printer for the current user on the local computer
_WinAPI_SetDIBits Sets the pixels in a compatible bitmap using the color data found in a DIB
_WinAPI_SetEndOfFile Sets the physical file size for the specified file to the current position of the file pointer
_WinAPI_SetEvent Sets the specified event object to the signaled state
_WinAPI_SetFilePointer Moves the file pointer of the specified file
_WinAPI_SetFocus Sets the keyboard focus to the specified window
_WinAPI_SetFont Sets a window font
_WinAPI_SetHandleInformation Sets certain properties of an object handle
_WinAPI_SetLastError Sets the last-error code for the calling thread
_WinAPI_SetLayeredWindowAttributes Sets Layered Window Attributes
_WinAPI_SetParent Changes the parent window of the specified child window
_WinAPI_SetProcessAffinityMask Sets a processor affinity mask for the threads of a specified process
_WinAPI_SetSysColors Obtains information about the display devices in a system
_WinAPI_SetTextColor Sets the current text color to the specified color value
_WinAPI_SetWindowLong Sets information about the specified window
_WinAPI_SetWindowPlacement Sets the placement of the window for Min, Max, and normal positions
_WinAPI_SetWindowPos Changes the size, position, and Z order of a child, pop-up, or top-level window
_WinAPI_SetWindowRgn Sets the window region of a window
_WinAPI_SetWindowsHookEx Installs an application-defined hook procedure into a hook chain
_WinAPI_SetWindowText Changes the text of the specified window's title bar
_WinAPI_ShowCursor Displays or hides the cursor
_WinAPI_ShowError Displays an error message box with an optional exit
_WinAPI_ShowMsg Displays an "Information" message box
_WinAPI_ShowWindow Sets the specified window's show state
_WinAPI_StringFromGUID Converts a binary GUID to string form
_WinAPI_StringLenA Calculates the size of ANSI string
_WinAPI_StringLenW Calculates the size of wide string
_WinAPI_SubLangId Extract sublanguage id from a language id
_WinAPI_SystemParametersInfo Retrieves or sets the value of one of the system-wide parameters
_WinAPI_TwipsPerPixelX Returns the width of a pixel, in twips
_WinAPI_TwipsPerPixelY Returns the height of a pixel, in twips
_WinAPI_UnhookWindowsHookEx Removes a hook procedure installed in a hook chain by the _WinAPI_SetWindowsHookEx function
_WinAPI_UpdateLayeredWindow Updates the position, size, shape, content, and translucency of a layered window
_WinAPI_UpdateWindow Updates the client area of a window by sending a WM_PAINT message to the window
_WinAPI_WaitForInputIdle Waits until a process is waiting for user input with no input pending, or a time out
_WinAPI_WaitForMultipleObjects Waits until one or all of the specified objects are in the signaled state
_WinAPI_WaitForSingleObject Waits until the specified object is in the signaled state
_WinAPI_WideCharToMultiByte Converts a Unicode string to a multibyte string
_WinAPI_WindowFromPoint Retrieves the handle of the window that contains the specified point
_WinAPI_WriteConsole Writes a character string to a console screen buffer
_WinAPI_WriteFile Writes data to a file at the position specified by the file pointer
_WinAPI_WriteProcessMemory Writes memory in a specified process