FML Programmer's Guide

 

This document describes the Field Manipulation Language (FML), including an overview of FML, instructions for defining the environment, instructions on field definition, and descriptions of field manipulation functions.

 

Introduction

About This Guide and FML

What Is FML?

How Does FML32 Fit into the BEA MessageQ System?

Who Is This Document For?

Prerequisites

What Does This Document Include?

What Other FML32 Documentation Is There?

Concepts and Definitions

 

Overview

Introduction

Dividing Records into Fields

Structures

Fielded Buffers

Implementing Fielded Buffers with FML32

FML32 Features

Fielded Buffer Structure

Supported Field Types

Field Name to Identifier Mappings

Run-Time: Field Table Files

Compile-Time: Header Files

Fielded Buffer Indexes

Multiple Occurrences of Fields

Boolean Expressions and Fielded Buffers

Error Handling

 

Setup

Introduction

Directory Structure

Environment Variables

 

Field Definition and Use

Introduction

Defining Fields

Field Names and Identifiers

Field Table Files

Field Table Example

Mapping Functions

Loading the Field Tables

Field Header Files

 

Field Manipulation Functions

Introduction

FML and FML32

FML32 Parameters

Field Identifier Mapping Functions

Fldid32

Fname32

Fldno32

Fldtype32

Ftype32

Fmkfldid32

Buffer Allocation and Initialization

Fielded32

Fneeded32

Finit32

Falloc32

Ffree32

Fsizeof32

Funused32

Fused32

Frealloc32

Functions for Moving Fielded Buffers

Fmove32

Fcpy32

Field Access and Modification Functions

Fadd32

Fappend32

Fchg32

Fcmp32

Fdel32

Fdelall32

Fdelete32

Ffind32

Ffindlast32

Ffindocc32

Fget32

Fgetalloc32

Fgetlast32

Fnext32

Fnum32

Foccur32

Fpres32

Fvals32 and Fvall32

Buffer Update Functions

Fconcat32

Fjoin32

Fojoin32

Fproj32

Fprojcpy32

Fupdate32

Conversion Functions

CFadd32

CFchg32

CFget32

CFgetalloc32

CFfind32

CFfindocc32

Converting Strings

Ftypcvt32

Conversion Rules

Indexing Functions

Fidxused32

Findex32

Frstrindex32

Funindex32

Example

Input/Output Functions

Fread32 and Fwrite32

Fchksum32

Fprint32 and Ffprint32

Fextread32

Boolean Expressions of Fielded Buffers

Boolean Expressions

Field Names and Types

Strings

Constants

Conversion

Primary Expressions

Expression Operators

Sample Boolean Expressions

Boolean Functions

Fboolco32

Fboolpr32

Fboolev32 and Ffloatev32

 

Examples

 

FML Error Messages