Unit 'icon' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#morphunits]

GetIconTagList

Retrieve an icon

Declaration

Source position: icon.pas line 370

function GetIconTagList(

  const name: pCHAR;

  const tags: PTagItem

):PDiskObject;

function GetIconTagList(

  const name: RawByteString;

  const tags: PTagItem

):PDiskObject;

Arguments

name

  

Name of the object an icon is to be retrieved for, or nil if a default icon is to be retrieved.

tags

  

Retrieval options. (ICONGETA_*)

Function result

Pointer to a struct DiskObject or nil in case of error. You can use IoErr() to retrieve the error code or use the ICONA_ErrorCode tag instead.

Arguments

name

  

Name of the object an icon is to be retrieved for, or nil if a default icon is to be retrieved.

tags

  

Retrieval options. (ICONGETA_*)

Description

This function is used to retrieve an icon; the icon can belong to a file/drawer/volume or it can be a default icon.

This function is a superset of GetDefDiskObject(), GetDiskObject() and GetDiskObjectNew().

If a palette-mapped icon is set to allocate its colours from the default screen, such as the Workbench screen, icon.library may resort to remap its colours in the course of Workbench screen close/reopen transitions. This means that you cannot depend upon the icon's image bitmaps to stay the same size, shape or colour. If this is what you need, you should either create your own images from the palette mapped data or make copies of the icon image bitmaps and the associated colour table.

If during Workbench close/open transitions the global remap screen becomes nil, GetIconTagList() may refuse to return a remapped icon and return with an error (ERROR_REQUIRED_ARG_MISSING) instead.

See also

GetDiskObject

  

Read in a Workbench disk object from disk.

GetDiskObjectNew

  

Read in a Workbench disk object from disk.

GetDefDiskObject

  

Read default wb disk object from disk.

IconControlA

  

Set and get icon and icon.library options

PutIconTagList

  

Store an icon


Documentation generated on: 2021-07-30