PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Constants used by the Windows functions:
ConstantUseWLanguage functions
Versions 17 and later
apiAnsiCharacter
New in version 17
apiAnsiCharacter
apiAnsiCharacter
The type of the API parameter or the type of the return variable of the API is an Ansi character.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiAnsiString
New in version 16
apiAnsiString
apiAnsiString
The type of the API parameter or the type of the return variable of the API is an Ansi string.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiBoolean
New in version 16
apiBoolean
apiBoolean
The type of the API parameter or the type of the return variable of the API is a boolean.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiBuffer
New in version 16
apiBuffer
apiBuffer
The type of the API parameter or the type of the return variable of the API is a buffer.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiCharacter
New in version 16
apiCharacter
apiCharacter
The type of the API parameter or the type of the return variable of the API is a character.
The type of the API parameter or the type of the return variable of the API is an Ansi character if the project is in Ansi mode, a Unicode character if the project is in Unicode mode.
Windows Mobile The parameter is always a Unicode character.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiFreeDLL
New in version 16
apiFreeDLL
apiFreeDLL
If the DLL was loaded to call the API, it will be unloaded. This constant is ignored if the DLL was already loaded during the call to the API.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiInt_4
New in version 16
apiInt_4
apiInt_4
The type of the API parameter or the type of the API return variable is an 4-byte integer.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiInt_8
New in version 16
apiInt_8
apiInt_8
The type of the API parameter or the type of the return variable of the API is a 8-byte integer.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
apiLockThreads
  • Used to find out whether API or CallDLL32 locks the threads during its execution.
  • Versions 16 and later
    If this constant is used in the API Description variable, the call to the API locks all the current threads. This is used to protect the external DLL from the multi-thread calls.
    New in version 16
    If this constant is used in the API Description variable, the call to the API locks all the current threads. This is used to protect the external DLL from the multi-thread calls.
    If this constant is used in the API Description variable, the call to the API locks all the current threads. This is used to protect the external DLL from the multi-thread calls.
APIParameter
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiReal_4
New in version 16
apiReal_4
apiReal_4
The type of the API parameter or the type of the API return variable is an 4-byte real.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiReal_8
New in version 16
apiReal_8
apiReal_8
The type of the API parameter or the type of the API return variable is a 8-byte real.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
apiRestoreSystemSettings
  • Used to find out whether API or CallDLL32 restores the regional system settings (language, display of decimals, ...) after the execution of the Windows API.
  • Versions 16 and later
    If this constant is used in the API Description variable, the system parameters will be restored after the call to the API. Indeed, some APIs modify the system parameters.
    New in version 16
    If this constant is used in the API Description variable, the system parameters will be restored after the call to the API. Indeed, some APIs modify the system parameters.
    If this constant is used in the API Description variable, the system parameters will be restored after the call to the API. Indeed, some APIs modify the system parameters.
APIParameter
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiString
New in version 16
apiString
apiString
The type of the API parameter or the type of the return variable of the API is a string.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiSystemInt
New in version 16
apiSystemInt
apiSystemInt
The type of the API parameter or the type of the API return variable is a system integer.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 17 and later
apiUnicodeCharacter
New in version 17
apiUnicodeCharacter
apiUnicodeCharacter
The type of the API parameter or the type of the return variable of the API is a Unicode character.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 16 and later
apiUnicodeString
New in version 16
apiUnicodeString
apiUnicodeString
The type of the API parameter or the type of the return variable of the API is a Unicode string.
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Versions 18 and later
CDECL
New in version 18
CDECL
CDECL
Convention for calling an API: method used: CDECL
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
kpAltControl key used: ALTKeyPressed
kpControlControl key used: CTRLKeyPressed
kpEscapeControl key used: ESCKeyPressed
kpLButtonControl key used: Left mouse buttonKeyPressed
kpRButtonControl key used: Right mouse buttonKeyPressed
kpShiftControl key used: SHIFTKeyPressed
shortcutDesktopCreates or deletes a shortcut on the Windows desktopCreateShortcut, DeleteShortCut
Versions 18 and later
shortcutFindWindows8
New in version 18
shortcutFindWindows8
shortcutFindWindows8
Shortcut created for the search in Windows 8 for all the users of the computer. The shortcut is not found on the home screen.
If the system used is not Windows 8, the shortcut is created in the "Start .. Programs" menu of Windows for all the users of the computer.
CreateShortcut, DeleteShortCut
shortcutFreeCreates or deletes a shortcut in the specified directoryCreateShortcut, DeleteShortCut
shortcutProgramCreates or deletes a shortcut in the "Start .. Programs" menu of WindowsCreateShortcut, DeleteShortCut
shortcutQuickLaunchCreates or deletes a shortcut in the quick launch bar (Windows 98 and later)CreateShortcut, DeleteShortCut
Versions 22 and later
shortcutStart
New in version 22
shortcutStart
shortcutStart
Creates or deletes a shortcut in the "Start" menu of Windows for all the users of the computer. CreateShortcut, DeleteShortCut
Versions 22 and later
shortcutStartup
New in version 22
shortcutStartup
shortcutStartup
Creates or deletes a shortcut in the "Start .. Programs .. Startup" menu of Windows for all the users of the computer. CreateShortcut, DeleteShortCut
Versions 22 and later
shortcutUserDesktop
New in version 22
shortcutUserDesktop
shortcutUserDesktop
Creates or deletes a shortcut on the Windows desktop for the current user of the computer. CreateShortcut, DeleteShortCut
Versions 22 and later
shortcutUserProgram
New in version 22
shortcutUserProgram
shortcutUserProgram
Creates or deletes a shortcut in the "Start .. Programs" menu of Windows for the current user of the computer. CreateShortcut, DeleteShortCut
Versions 22 and later
shortcutUserStart
New in version 22
shortcutUserStart
shortcutUserStart
Creates or deletes a shortcut in the "Start" menu of Windows for the current user of the computer. CreateShortcut, DeleteShortCut
Versions 22 and later
shortcutUserStartup
New in version 22
shortcutUserStartup
shortcutUserStartup
Creates or deletes a shortcut in the "Start .. Programs .. Startup" menu of Windows for the current user of the computer. CreateShortcut, DeleteShortCut
Versions 18 and later
STDCALL
New in version 18
STDCALL
STDCALL
Convention for calling an API: method used: STDCALL
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
swsIconicOpens the application window in minimized modeCreateShortcut
swsMaximizeOpens the application window in maximized modeCreateShortcut
swsNormalOpens the application window in standard modeCreateShortcut
Versions 18 and later
THISCALL
New in version 18
THISCALL
THISCALL
Convention for calling an API: method used: THISCALL
Versions 16 and later
API Description variable
New in version 16
API Description variable
API Description variable
Minimum required version
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment