Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In both cases, for the setup file and the input string, if a specied specified FPA is missing then it will not
affect subsequent entries. Therefore, a setup file with these contents:

...

Code Block
FPA-1 20090123
FPA-2 20090346
FPA-3 empty
FPA-4 20090245

Output

INT_X : number of instances opened successfully

...

INT_X F_CloseInstances ( void );

Input

none.

Output

INT_X : success or failed

  • TRUE (1) - success

  • FALSE (0) - failed

...

BYTE fpa : desired FPA index, 1 to 64, or 0 for all

Output

INT_X : success or error

  • TRUE (1), used FPA index is valid

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F OpenInstancesAndFPAs or index out of range

...

Code Block
languagecpp
INT_X F_Check_FPA_index ( void );

Input

none.

Output

INT_X : current fpa index if valid

...

BYTE fpa : desired FPA index, 1 to 64.

Output

INT_X : Last return value from the selected FPA (API-DLL instance).

  • INT_X type return value from last function call on selected FPA

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

...

BYTE fpa : desired FPA index, 1 to 64

Output

INT_X : serial number

  • SN of selected FPA

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

...

Code Block
languagecpp
#define ADAPTER_HARDWARE_PN_SIZE		16	
#define ADAPTER_DESCRIPTION_SIZE		32
#define FPA_LABEL_SIZE					((ADAPTER_HARDWARE_PN_SIZE + ADAPTER_DESCRIPTION_SIZE)*sizeof(char) + 12*sizeof(BYTE) + sizeof(long))
union FPA_LABEL
{
	BYTE	bytes[ FPA_LABEL_SIZE ];
	struct
	{
		long  SN;
		BYTE  hardware_ID;
		BYTE  hardware_SubID;
		BYTE  full_access;
		BYTE  Interface_Type;
		BYTE  Valid_access_key;
		BYTE  spare3;
		BYTE  spare4;
		BYTE  spare5;
		BYTE  spare6;
		BYTE  spare7;
		BYTE  spare8;
		BYTE  spare9;
		char  adapter_hardware_PN[ ADAPTER_HARDWARE_PN_SIZE ];
		char  adapter_description[ ADAPTER_DESCRIPTION_SIZE ];
	}x;
};

Output

INT_X : serial number, hardware ID, meta-data

  • updated FPA_LABEL structure pointed to by label input parameter

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

...

Code Block
languagecpp
#define MAX_ID_DESC		 15
#define MAX_ACCESS_DESC	 32
typedef struct
{
	UINT32  active;
	UINT32  SN;
	UINT32  CommType;
	UINT32  HW_ID;
	UINT32  HW_rev;
	char  text[MAX_ID_DESC+1];
	char  access_text[MAX_ACCESS_DESC+1];
} ALL_FPA_LIST;

//i.e.: 
ALL_FPA_LIST FPA_List[MAX_USB_DEV_NUMBER];
//F_Get_FPA_List(FPA_List);
INT_X  MSPPRG_API	F_Get_FPA_List( ALL_FPA_LIST * FPA_List );	// FPA_List -> size MAX_USB_DEV_NUMBER

Output

INT_X : number of active adapters

...

BYTE fpa : desired FPA index, 1 to 64.

Output

INT_X : progress indicator

  • value between 0 and 100

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

...

BYTE fpa : desired FPA index, 1 to 64.

Output

INT_X : opcode of currently running sub-operation

...