MODULE GFAXDEF IDENT "GFAXDEF-1-X";
{++
{ Facility:
{   Gold-Fax API
{ 
{ Abstract:
{   An interface module defined GFAX API structures, constants, routines. This
{  "story" baes on the "Gold-Fax Application Program Interface"
{   by Data Processing Design, Inc.
{ 
{ Author:
{   Ruslan R. Laishev
{ 
{ Creation Date: 22-JAN-2004
{ 
{ Modification History:
{--



/*
/**++
/**
/**	Gold-Fax flags
/**
/**--
/*
AGGREGATE	gf_flags STRUCTURE PREFIX "GF_";
		COURIER_12PT	BITFIELD MASK;
		COURIER_10PT	BITFIELD MASK;
		DRAFT		BITFIELD MASK;
		HP		BITFIELD MASK;
		IGNORE_PROFILE	BITFIELD MASK;
		LANDSCAPE	BITFIELD MASK;
		LINEPRINTER_8PT	BITFIELD MASK;
		MAIL_FAIL	BITFIELD MASK;
		MAIL_SUCCESS	BITFIELD MASK;
		NOTIFY		BITFIELD MASK;
		ONCOVER		BITFIELD MASK;
		OVERRIDE	BITFIELD MASK;
		PAPERSIZE_A4	BITFIELD MASK;
		PAPERSIZE_LEGAL	BITFIELD MASK;
		PAPERSIZE_LETTER BITFIELD MASK;
		PORTRAIT	BITFIELD MASK;
		PS		BITFIELD MASK;
		SIGNAL		BITFIELD MASK;
		TRUNCATE	BITFIELD MASK;
		URGENT		BITFIELD MASK;
		VERTRES_FINE	BITFIELD MASK;
		VERTRES_STANDARD BITFIELD MASK;
	END gf_flags;

/*
/**++
/**
/**	Gold-Fax statuses
/**
/**--
/*
AGGREGATE	gfs_flags STRUCTURE PREFIX "GFS_";
		PENDING		BITFIELD MASK;
		HOLDING		BITFIELD MASK;
		PROCESSING	BITFIELD MASK;
		SENDING		BITFIELD MASK;
		ABORTED		BITFIELD MASK;
		RETRY		BITFIELD MASK;
		SUCCESS		BITFIELD MASK;
		FAILURE		BITFIELD MASK;
		WARNING		BITFIELD MASK;
		ERROR		BITFIELD MASK;
		DELETED		BITFIELD MASK;
	END gfs_flags;

/*
/**++
/**
/**	GFAX API Routines declataion section
/**
/**--
/*

/*
/**++
/**
/** The GFAX_SEND_DIAL routine send a fax to a phone number and 
/** returns the Gold-Fax ID number of the submtited fax.
/**
/**--
/*

ENTRY	gfax_send_dial ALIAS GFAX_SEND_DIAL	PARAMETER (
	LONGWORD UNSIGNED NAMED		pullID		OUT,
	CHARACTER DESCRIPTOR NAMED	pdFileName	IN,
	CHARACTER DESCRIPTOR NAMED	pdDial		IN,
	CHARACTER DESCRIPTOR NAMED	pdTo		IN,
	CHARACTER DESCRIPTOR NAMED	pdCompany	IN,
	CHARACTER DESCRIPTOR NAMED	pdAdress	IN,
	CHARACTER DESCRIPTOR NAMED	pdSubject1	IN,
	CHARACTER DESCRIPTOR NAMED	pdSubject2	IN,
	CHARACTER DESCRIPTOR NAMED	pdFrom		IN,
	CHARACTER DESCRIPTOR NAMED	pdCoverPage	IN,
	LONGWORD UNSIGNED NAMED ulFlags VALUE		IN TYPENAME gf_flags,
	CHARACTER DESCRIPTOR NAMED	pdAfterTime	IN,
	CHARACTER DESCRIPTOR NAMED	pdUser1		IN,
	CHARACTER DESCRIPTOR NAMED	pdUser2		IN,
	CHARACTER DESCRIPTOR NAMED	pdForm		IN,
	CHARACTER DESCRIPTOR NAMED	pdCvrFaxNumber	IN,
	CHARACTER DESCRIPTOR NAMED	pdCvrPhoneNumber IN,
	CHARACTER DESCRIPTOR NAMED	pdIdString	IN,
	CHARACTER DESCRIPTOR NAMED	pdMailAdress	IN,
	LONGWORD UNSIGNED NAMED pulIndent	IN,
	LONGWORD UNSIGNED NAMED pulPSSize	IN,
	CHARACTER DESCRIPTOR NAMED	pdDraftQueueName IN
	) RETURNS  LONGWORD TYPENAME CONDVALU;


/*
/**++
/**
/** The GFAX_SEND_NAME routine send a fax using or more Gold-Fax
/** phonebook names and returns the Gold-Fax ID number of the submited fax
/**
/**--
/*

ENTRY	gfax_send_name ALIAS GFAX_SEND_NAME	PARAMETER (
	LONGWORD UNSIGNED NAMED		pullID		OUT,
	CHARACTER DESCRIPTOR NAMED	pdFileName	IN,
	CHARACTER DESCRIPTOR NAMED	pdName		IN,
	CHARACTER DESCRIPTOR NAMED	pdSubject1	IN,
	CHARACTER DESCRIPTOR NAMED	pdSubject2	IN,
	CHARACTER DESCRIPTOR NAMED	pdFrom		IN,
	CHARACTER DESCRIPTOR NAMED	pdCoverPage	IN,
	LONGWORD UNSIGNED NAMED ulFlags VALUE		IN TYPENAME gf_flags,
	CHARACTER DESCRIPTOR NAMED	pdAfterTime	IN,
	CHARACTER DESCRIPTOR NAMED	pdUser1		IN,
	CHARACTER DESCRIPTOR NAMED	pdUser2		IN,
	CHARACTER DESCRIPTOR NAMED	pdForm		IN,
	CHARACTER DESCRIPTOR NAMED	pdCvrFaxNumber	IN,
	CHARACTER DESCRIPTOR NAMED	pdCvrPhoneNumber IN,
	CHARACTER DESCRIPTOR NAMED	pdIdString	IN,
	CHARACTER DESCRIPTOR NAMED	pdMailAdress	IN,
	LONGWORD UNSIGNED NAMED pulIndent	IN,
	LONGWORD UNSIGNED NAMED pulPSSize	IN,
	CHARACTER DESCRIPTOR NAMED	pdDraftQueueName IN
	) RETURNS  LONGWORD TYPENAME CONDVALU;


/*
/**++
/**
/** The GFAX_STATUS_JOB routine allows you to obtain the status of a submited fax 
/** based on a passed ID string.
/**
/**--
/*

ENTRY	gfax_status_job ALIAS GFAX_STATUS_JOB	PARAMETER (
	CHARACTER DESCRIPTOR NAMED	pdUsername	IN,
	LONGWORD UNSIGNED NAMED ulID VALUE		IN,
	LONGWORD UNSIGNED NAMED pulStatusFlags		OUT TYPENAME gfs_flags,
	CHARACTER DESCRIPTOR NAMED	pdDateTime	OUT,
	CHARACTER DESCRIPTOR NAMED	pdAdress	OUT,
	CHARACTER DESCRIPTOR NAMED	pdSubject1	OUT,
	CHARACTER DESCRIPTOR NAMED	pdSubject2	OUT,
	CHARACTER DESCRIPTOR NAMED	pdFrom		IN,
	LONGWORD UNSIGNED NAMED		pulSuccess	OUT,
	LONGWORD UNSIGNED NAMED		pulFail		OUT,
	LONGWORD UNSIGNED NAMED		pulWarning	OUT,
	LONGWORD UNSIGNED NAMED		pulRetry	OUT,
	CHARACTER DESCRIPTOR NAMED	pdUser1		IN,
	CHARACTER DESCRIPTOR NAMED	pdUser2		IN,
	CHARACTER DESCRIPTOR NAMED	pdIDSrting	IN
	) RETURNS  LONGWORD TYPENAME CONDVALU;
END_MODULE GFAXDEF;