# WFSTableFormat

## Definition

  `#include <nitro/wfs.h>`

      /* WFS table format array order */
      typedef enum WFSTableRegionType
      {
          WFS_TABLE_REGION_FAT,
          WFS_TABLE_REGION_FNT,
          WFS_TABLE_REGION_OV9,
          WFS_TABLE_REGION_OV7,
          WFS_TABLE_REGION_MAX
      }
      WFSTableRegionType;

      /* ROM file table information */
      typedef struct WFSTableFormat
      {
          u32             origin;                       /* ROM image offset */
          u8             *buffer;                       /* Buffer used to store file table information */
          u32             length;                       /* buffer size */
          CARDRomRegion   region[WFS_TABLE_REGION_MAX]; /* The storage locations of each FAT, FNT, and overlay table */
      } PLATFORM_STRUCT_PADDING_FOOTER
      WFSTableFormat;

## Elements

origin | Offset value that indicates where address 0 of the ROM image is located within the actual ROM device from the perspective of the child (client). Applications do not particularly need to consider this.
buffer | This memory is used to store information for each table pointed by the region member to be described later.
length | The buffer size.

region

This memory region stores information for each FAT, FNT, and overlay table stored in the buffer.
For instance, FNT information can be accessed as described below.

- Start Address = buffer + region[WFS_TABLE_REGION_FNT] offset
- Table Size = region[WFS_TABLE_REGION_FNT].length

## Description

This structure represents file table information to be retrieved by children (clients) using `WFS_GetTableFormat`.

## See Also

`CARDRomRegion, WFS_GetTableFormat`

## Revision History

2007/06/06 Initial version.

CONFIDENTIAL