Copyright (c) Hyperion Entertainment and contributors.

Difference between revisions of "Utility Library"

From AmigaOS Documentation Wiki
Jump to navigation Jump to search
Line 6: Line 6:
 
== Function Reference ==
 
== Function Reference ==
   
The tables which follow contain breif descriptions of the functions inside the utility library. See the SDK for details on each function call.
+
The tables which follow contain brief descriptions of the functions inside the utility library. See the SDK for details on each function call.
 
=== Tag Function Reference ===
 
 
The following are brief descriptions of the utility library functions which pertain to tags and tag lusts.
 
 
{| class="wikitable"
 
! Function
 
! Description
 
|-
 
| AllocSysObjectTags(ASOT_TAGLIST)
 
| Allocate a TagItem array (or chain).
 
|-
 
| FreeSysObject(ASOT_TAGLIST)
 
| Frees allocated TagItem lists.
 
|-
 
| CloneTagItems()
 
| Copies a TagItem list.
 
|-
 
| RefreshTagItemClone()
 
| Rejuvenates a clone from the original.
 
|-
 
| FindTagItem()
 
| Scans TagItem list for a tag.
 
|-
 
| GetTagData()
 
| Obtain data corresponding to tag.
 
|-
 
| NextTagItem()
 
| Iterate TagItem lists.
 
|-
 
| TagInArray()
 
| Check if a tag value appears in a Tag array.
 
|-
 
| FilterTagChanges()
 
| Eliminate TagItems which specify no change.
 
|-
 
| FilterTagItems()
 
| Remove selected items from a TagItem list.
 
|-
 
| MapTags()
 
| Convert ti_Tag values in a list via map pairing.
 
|-
 
| PackBoolTags()
 
| Builds a "Flag" word from a TagItem list.
 
|}
 
 
=== Callback Hook Function Reference ===
 
 
The following are brief descriptions of the utility library functions which pertain to callback hooks.
 
 
{| class="wikitable"
 
! Function
 
! Description
 
|-
 
| CallHookPkt()
 
| Call a standard callback Hook function.
 
|}
 
   
 
=== International String Function Reference ===
 
=== International String Function Reference ===

Revision as of 22:22, 26 March 2014

WIP.png This page is currently being updated to AmigaOS 4.x. Some of the information contained here may not yet be applicable in part or totally.

Utility Library

Utility library is the home for all the OS functions which don't fit in the other libraries. Among the calls in utility library are calls to manage tags and tag lists, callback hooks, and some generic 32-bit math functions, all discussed below.

Function Reference

The tables which follow contain brief descriptions of the functions inside the utility library. See the SDK for details on each function call.

International String Function Reference

The following are brief descriptions of the utility library functions which pertain to string operations using the international ASCII character set.

Function Description
Stricmp() Compare strings, case-insensitive.
Strnicmp() Compare strings, case-insensitive, with specified length.
ToLower() Convert a character to lower case.
ToUpper() Convert a character to upper case.

Date Function Reference

The following are brief descriptions of the utility library functions which pertain to date conversion.

Function Description
CheckDate() Check the legality of a date.
Amiga2Date() Calculate the date from a specified timestamp.
Date2Amiga() Calculate the timestamp from a specified date.