Jump to content

WinFreeFileIcon: Difference between revisions

From EDM2
Created page with "This function frees an icon pointer that was originally allocated by WinLoadFileIcon. ==Syntax== WinFreeFileIcon(hptr) ==Parameters== ;hptr (HPOINTER) - input :A pointer t..."
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This function frees an icon pointer that was originally allocated by WinLoadFileIcon.  
This function frees an icon pointer that was originally allocated by [[WinLoadFileIcon]].


==Syntax==
==Syntax==
Line 5: Line 5:


==Parameters==
==Parameters==
;hptr (HPOINTER) - input
;''hptr'' ([[HPOINTER]]) - input:A pointer to an icon loaded by WinLoadFileIcon.
:A pointer to an icon loaded by WinLoadFileIcon.  


==Returns==
==Returns==
;rc (BOOL) - returns
;''rc'' ([[BOOL]]) - returns:Success indicator.
:Success indicator.
:;TRUE:Successful completion
:;TRUE
:;FALSE:Error occurred.
::Successful completion
:;FALSE
::Error occurred.


==Example Code==
==Example Code==
Definition
Definition
<pre>
<pre>
Line 30: Line 25:


==Related Functions==
==Related Functions==
* WinSetFileIcon
* [[WinSetFileIcon]]
* WinLoadFileIcon  
* [[WinLoadFileIcon]]


[[Category:Win]]
[[Category:Win]]

Latest revision as of 04:42, 15 June 2025

This function frees an icon pointer that was originally allocated by WinLoadFileIcon.

Syntax

WinFreeFileIcon(hptr)

Parameters

hptr (HPOINTER) - input
A pointer to an icon loaded by WinLoadFileIcon.

Returns

rc (BOOL) - returns
Success indicator.
TRUE
Successful completion
FALSE
Error occurred.

Example Code

Definition

#define INCL_WINWORKPLACE
#include <os2.h>

HPOINTER    hptr;  /*  A pointer to an icon loaded by WinLoadFileIcon. */
BOOL        rc;    /*  Success indicator. */

rc = WinFreeFileIcon(hptr);

Related Functions