WinFreeErrorInfo: Difference between revisions

Latest revision as of 23:53, 9 May 2020

Releases the memory occupied by the ERRINFO type that was allocated by WinGetErrorInfo.

WinFreeErrorInfo(errInfo)

Returns BOOL with value of:

INCL_WINERROR or INCL_WIN or INCL_PM

ERRINFO  errorInfo;
BOOL     rc;
...
rc = WinFreeErrorInfo(errorInfo);
...

@@ Line 1: / Line 1: @@
-== WinFreeErrorInfo ==
+Releases the memory occupied by the [[ERRINFO]] type that was allocated by [[WinGetErrorInfo]].
-; WinFreeErrorInfo(errInfo) :
-Releases the memory occupied by the [[OS2 API:DataType:ERRORINFO|ERRORINFO]] type that was allocated by [[OS2 API:WinGetErrorInfo|WinGetErrorInfo]].
-=== Parameters ===
+==Syntax==
-; errInfo - [[OS2 API:DataType:ERRORINFO|ERRORINFO]] - input :
+ WinFreeErrorInfo(errInfo)
-Memory block to be released.
-=== Constants ===
+==Parameters==
-None
+;errInfo - [[ERRINFO]] - input : Memory block to be released.
-=== Returns ===
+==Returns==
-Returns [[OS2 API:DataType:BOOL|BOOL]] with value of:
+Returns [[BOOL]] with value of:
-* [[OS2 API:DataType:TRUE|TRUE]]
+*[[TRUE]]
-* [[OS2 API:DataType:FALSE|FALSE]]
+*[[FALSE]]
-=== Module ===
 === Define (C/C++) ===
-INCL_DOSPROCESS
+INCL_WINERROR or INCL_WIN or INCL_PM
-=== Export name/Ordinal ===
+=== Calling Convention ===
-=== Calling conversion ===
 [[Cdecl32]]
-=== Example Code ===
+==Example Code==
-  [[OS2 API:DataType:ERRORINFO|ERRORINFO]]  errorInfo;
+  ERRINFO  errorInfo;
-  [[OS2 API:DataType:BOOL|BOOL]]       rc;
+  BOOL     rc;
   ...
   rc = WinFreeErrorInfo(errorInfo);
   ...
-=== Related Functions ===
+==Related Functions==
-[[OS2 API:WinGetErrorInfo|WinGetErrorInfo]]
+*[[WinGetErrorInfo]]
-[[OS2 API:WinGetLastError|WinGetLastError]]
+*[[WinGetLastError]]
-=== Notes ===
-=== OS Version Introduced ===
+[[Category:Win]]