home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Amiga Shareware Floppies / ma76.lha / MAShare76 / Identify / identify.doc < prev    next >
Text File  |  1996-09-14  |  9KB  |  262 lines
  1. TABLE OF CONTENTS
  2.  
  3. identify.library/IdAlert
  4. identify.library/IdExpansion
  5. identify.library/IdFunction
  6. identify.library/IdHardware
  7.  
  8. identify.library/IdAlert                              identify.library/IdAlert
  9.  
  10.    NAME
  11.         IdAlert - get description of an alert (V3)
  12.  
  13.    SYNOPSIS
  14.         Error = IdAlert(Code,TagList)
  15.         D0.l            D0.l   A0.l
  16.  
  17.         LONG IdAlert(ULONG, struct TagItem *);
  18.  
  19.         Error = IdAlertTags(Code,Tag1,...)
  20.  
  21.         LONG IdAlertTags(ULONG, ULONG,...);
  22.  
  23.    FUNCTION
  24.         Get a human readable description of the alert ('Guru') code.
  25.  
  26.    INPUTS
  27.         Code          -- (ULONG) alert code, as defined in exec/alerts.h
  28.  
  29.         TagList       -- (struct TagItem *) tags that describe further
  30.                          options:
  31.  
  32.                 IDTAG_DeadStr   -- (STRPTR) Alert type string (deadend
  33.                         or recoverable). You may skip this tag if you
  34.                         do not want to get the string.
  35.                 IDTAG_SubsysStr -- (STRPTR) String of the subsystem
  36.                         that caused the alert (CPU, exec.library, ...).
  37.                         You may skip this tag if you do not want to
  38.                         get the string.
  39.                 IDTAG_GeneralStr -- (STRPTR) General alert cause. You
  40.                         may skip this tag if you do not want to get
  41.                         the string.
  42.                 IDTAG_SpecStr   -- (STRPTR) Specified alert cause. You
  43.                         may skip this tag if you do not want to get
  44.                         the string.
  45.                 IDTAG_StrLength -- (UWORD) Maximum length of the
  46.                         string buffer, including termination. Defaults
  47.                         to 50.
  48.  
  49.    RESULT
  50.         Error         -- (LONG) error code, or 0 if everything went fine.
  51.  
  52.    NOTE
  53.         This call is guaranteed to preserve all registers except D0.
  54.  
  55.    BUGS
  56.  
  57.    SEE ALSO
  58.  
  59. identify.library/IdExpansion                      identify.library/IdExpansion
  60.  
  61.    NAME
  62.         IdExpansion - get name of expansion board (V3)
  63.  
  64.    SYNOPSIS
  65.         Error = IdExpansion(TagList)
  66.         D0.l                  A0.l
  67.  
  68.         LONG IdExpansion(struct TagItem *);
  69.  
  70.         Error = IdExpansionTags(Tag1,...)
  71.  
  72.         LONG IdExpansionTags(ULONG,...);
  73.  
  74.    FUNCTION
  75.         Gets the name and class of the expansion and it's manufacturer.
  76.  
  77.    INPUTS
  78.         TagList       -- (struct TagItem *) tags that describe further
  79.                          options:
  80.  
  81.                 IDTAG_ConfigDev -- (struct ConfigDev *) ConfigDev
  82.                         structure containing all information. You
  83.                         should use this tag if ever possible, since
  84.                         there are more possibilities to recognize and
  85.                         distinguish between a board.
  86.                 IDTAG_ManufID   -- (UWORD) Manufacturer ID if ConfigDev
  87.                         is not provided. You also have to provide
  88.                         IDTAG_ProdID!
  89.                 IDTAG_ProdID    -- (UBYTE) Product ID if ConfigDev
  90.                         is not provided. You also have to provide
  91.                         IDTAG_ManufID!
  92.                 IDTAG_ManufStr  -- (STRPTR) Pointer to a buffer space
  93.                         for the manufacturer name. You may skip this
  94.                         tag if you do not want to get this string.
  95.                 IDTAG_ProdStr   -- (STRPTR) Pointer to a buffer space
  96.                         for the product name. You may skip this tag if
  97.                         you do not want to get this string.
  98.                 IDTAG_ClassStr  -- (STRPTR) Pointer to a buffer space
  99.                         for the product class. You may skip this tag if
  100.                         you do not want to get this string.
  101.                 IDTAG_StrLength -- (UWORD) Buffer length, including
  102.                         termination. Defaults to 50.
  103.  
  104.    RESULT
  105.         Error         -- (LONG) error code, or 0 if everything went fine.
  106.  
  107.    NOTE
  108.         If the manufacturer or the product is not known, the string will be
  109.         filled with its number.
  110.  
  111.         This call is guaranteed to preserve all registers except D0.
  112.  
  113.    BUGS
  114.         There are by far not all existing boards implemented. Please send
  115.         the manufacturer id and name and the products id, name and class
  116.         of all unknown boards to me. My E-Mail: "rkoerber@tfh.dssd.sub.org".
  117.  
  118.    SEE ALSO
  119.  
  120. identify.library/IdFunction                        identify.library/IdFunction
  121.  
  122.    NAME
  123.         IdFunction - identify function name by offset (V4)
  124.  
  125.    SYNOPSIS
  126.         Error = IdFunction(LibName,Offset,TagList)
  127.         D0.l                A0.l    D0.l   A1.l
  128.  
  129.         LONG IdFunction(STRPTR, LONG, struct TagItem *);
  130.  
  131.         Error = IdFunctionTags(LibName,Offset,Tag1,...)
  132.  
  133.         LONG IdFunctionTags(STRPTR, LONG, ULONG,...);
  134.  
  135.    FUNCTION
  136.         Decodes the offset of the provided library name into function name.
  137.  
  138.         This function requires the .fd files in a drawer with 'FD:' assigned
  139.         to it. All files must have the standard file name format, e.g.
  140.         'exec_lib.fd'.
  141.  
  142.         The appropriate .fd file will be scanned. The result will be
  143.         cached until the identify.library is removed from system.
  144.  
  145.    INPUTS
  146.         LibName       -- (STRPTR) name of the function's library, device
  147.                         or resource. All letters behind the point (and
  148.                         the point itself) are optional. The name is
  149.                         case sensitive.
  150.  
  151.                         Examples: 'exec.library', 'dos', 'cia.resource'.
  152.  
  153.         Offset        -- (LONG) offset of the function. It must be a
  154.                         multiple of 6. You do not need to provide the
  155.                         minus sign.
  156.  
  157.                         Examples: -456, 60
  158.  
  159.         TagList       -- (struct TagItem *) tags that describe further
  160.                         options:
  161.  
  162.                 IDTAG_FuncNameStr -- (STRPTR) Buffer where the function
  163.                         name will be copied into.
  164.  
  165.                 IDTAG_StrLength -- (UWORD) Maximum length of the
  166.                         string buffer, including termination. Defaults
  167.                         to 50.
  168.  
  169.    RESULT
  170.         Error         -- (LONG) error code, or 0 if everything went fine.
  171.  
  172.    NOTE
  173.         This call is guaranteed to preserve all registers except D0.
  174.  
  175.    BUGS
  176.         Every line in the .fd file must have a maximum of 98 characters.
  177.         Otherwise the internal offset table may be corrupted (but the
  178.         system won't crash). Anyhow, this should be no problem.
  179.  
  180.    SEE ALSO
  181.  
  182. identify.library/IdHardware                        identify.library/IdHardware
  183.    NAME
  184.         IdHardware - get information about the system (V3)
  185.  
  186.    SYNOPSIS
  187.         String = IdHardware(Type,TagList)
  188.          D0.l               D0.l   A0.l
  189.  
  190.         STRPTR IdHardware(ULONG, struct TagItem *);
  191.  
  192.         String = IdHardwareTags(Type,Tag1,...)
  193.  
  194.         STRPTR IdHardwareTags(ULONG, ULONG,...);
  195.  
  196.    FUNCTION
  197.         Gets information about the current system environment. This function
  198.         is fully DraCo compatible!
  199.  
  200.    INPUTS
  201.         Type          -- (ULONG) Information type. These types are known:
  202.  
  203.                 IDHW_SYSTEM     -- What system is used?
  204.                         (e. g. "Amiga 4000")
  205.  
  206.                 IDHW_CPU        -- What kind of CPU is available?
  207.                         (e. g. "68060")
  208.  
  209.                 IDHW_FPU        -- What kind of FPU is available?
  210.                         (e. g. "68060")
  211.  
  212.                 IDHW_MMU        -- What kind of MMU is available?
  213.                         (e. g. "68060")
  214.  
  215.                 IDHW_OSVER      -- What OS version is used?
  216.                         (e.g. "V39.106")
  217.  
  218.                 IDHW_EXECVER    -- What exec version is used?
  219.                         (e.g. "V39.47")
  220.  
  221.                 IDHW_WBVER      -- What WorkBench version is used?
  222.                         (e.g. "V39.29")
  223.  
  224.                 IDHW_ROMSIZE    -- Size of AmigaOS ROM
  225.                         (e.g. "512KB")
  226.  
  227.                 IDHW_CHIPSET    -- What Chipset is available?
  228.                         (e.g. "AGA")
  229.  
  230.                 IDHW_GFXSYS     -- What Graphic Board System is used?
  231.                         (e.g. "CyberGraphX")
  232.  
  233.                 IDHW_CHIPRAM    -- Size of complete Chip RAM
  234.                         (e.g. "2MB")
  235.  
  236.                 IDHW_FASTRAM    -- Size of complete Fast RAM
  237.                         (e.g. "12MB")
  238.  
  239.                 IDHW_RAM        -- Size of complete System RAM
  240.                         (e.g. "14MB")
  241.  
  242.                 IDHW_SETPATCHVER -- [V4] Version of current SetPatch
  243.                         (e.g. "V40.14")
  244.  
  245.         TagList       -- (struct TagItem *) tags that describe further
  246.                          options. Currently, there are none. You may
  247.                          provide NULL.
  248.  
  249.    RESULT
  250.         String        -- (STRPTR) String containing the desired
  251.                 information, or NULL if not available. Note that
  252.                 all strings are READ ONLY!
  253.  
  254.    NOTE
  255.         This call is guaranteed to preserve all registers except D0.
  256.  
  257.    BUGS
  258.  
  259.    SEE ALSO
  260.  
  261.  
  262.