Jump to content

WinSetFileIcon: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
 
(2 intermediate revisions by one other user not shown)
Line 2: Line 2:


==Syntax==
==Syntax==
  WinSetFileIcon(pFileName, picon);
  WinSetFileIcon(pFileName, picon)


==Parameters==
==Parameters==
; ''pFileName'' ([[PSZ]]) - input:Pointer to file name.
; ''pFileName'' ([[PSZ]]) - input:Pointer to file name.
:A pointer to a zero-terminated string which contains the name of the file whose icon will be set.
:A pointer to a zero-terminated string which contains the name of the file whose icon will be set.
;''picon'' ([[PICONINFO]]) - input:A pointer to an ICONINFO structure containing an icon specification.
;''picon'' (PICONINFO) - input:A pointer to an ICONINFO structure containing an icon specification.


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


==Remarks==
==Remarks==

Latest revision as of 20:34, 12 April 2024

WinSetFileIcon sets the icon for the file specified by pFileName to the icon specified by picon.

Syntax

WinSetFileIcon(pFileName, picon)

Parameters

pFileName (PSZ) - input
Pointer to file name.
A pointer to a zero-terminated string which contains the name of the file whose icon will be set.
picon (PICONINFO) - input
A pointer to an ICONINFO structure containing an icon specification.

Returns

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

Remarks

The specified icon is written to the file's .ICON extended attribute.

Example Code

Definition

#define INCL_WINPOINTERS
#include <os2.h>

PSZ          pFileName;  /*  Pointer to file name. */
PICONINFO    picon;      /*  A pointer to an ICONINFO structure containing an icon specification. */
BOOL         rc;         /*  Success indicator. */

rc = WinSetFileIcon(pFileName, picon);

Related Functions