CompuScope SDK Manua.. - Egmont Instruments

More documents

Recommendations

Info

gage_board_type_size_to_text Syntax C: LPSTR GAGEAPI gage_board_type_size_to_text (LPSTR string, uInt32 string_size, uInt32 action, uInt32 board, uInt32 far *bt, uInt32 far *eeopt, uInt32 far *ver, uInt32 far *max_mem); Remarks The gage_board_type_size_to_text routine is used to convert the board type parameter, returned by the drivers, into a text string that indicates the corresponding CompuScope model and/or memory size. The parameter string is a pointer to the string into which the CompuScope name will be returned by the routine. string_size is the size of the string pointed to by string. action can be one of the following constants defined in GAGE_DRV.H file:- GAGE_GBTSTT_BOARD GAGE_GBTSTT_MEMORY GAGE_GBTSTT_BOTH GAGE_GBTSTT_LONG_NAME GAGE_GBTSTT_ALL_UPPER_CASE 0x01 0x02 0x03 0x04 0x08 These constants determine in which format the string is returned. The constants can be ‘ORed’ together in order to request, say, CompuScope’s LONG_NAME in ALL_UPPER_CASE.. board is the CompuScope board number from which information is to be requested (referred to as the “currently selected CompuScope”). If this parameter is 0 then the installed hardware is ignored and the returned string contents are determined by the following four parameters. *bt returns the type of the currently selected CompuScope. This will be a combination of predefined constants GAGE_ASSUME_XXXXX, where XXXXX is a board type. Board type constants are defined in GAGE_DRV.H file. *eeopt returns the available eeprom options for the currently selected CompuScope. The options are represented by one or more constants “ORed” together. The available constants are defined in EEPROM.H *ver returns the hardware version of the currently selected CompuScope. *max_mem returns the size of the memory on the currently selected CompuScope. If *bt, *eeopt, *ver and *max_mem values are NULL, the routine will fill them. Return Value Returns the pointer to the string with above-mentioned parameters. See Also: gage_support_to_text Examples C: gage_board_type_size_to_text (str, sizeof(str), 1L, 1,NULL, NULL, NULL, NULL); CompuScope API Reference Manual 17
gage_busy Syntax C: int16 GAGEAPI gage_busy (void); Visual BASIC: function gage_busy () As Integer Remarks gage_busy determines if the CompuScope board is busy capturing data. The on-board memory of the CompuScope board cannot be accessed while the board is capturing the data. Generally, therefore, gage_busy is repeatedly called until it returns a 0 before download of data from on-board CompuScope memory is attempted. Return Value A non-zero or true value is returned if the board is busy (capturing data); otherwise a 0 value is returned. See also gage_triggered Examples C: is_busy = gage_busy (); Visual BASIC: is_busy = gage_busy CompuScope API Reference Manual 18
Page 1 and 2: Volume II: CompuScope Applications
Page 3 and 4: Gage Applied Technologies, Inc. Sof
Page 5: Global Table of Contents Volume I C
Page 8 and 9: gage_normalize_address 43 gage_powe
Page 11 and 12: III CompuScope API Routines This se
Page 13 and 14: Recommended Routines - Quick Summar
Page 15 and 16: Data Transfer Routines Name of the
Page 17 and 18: Recommended API Routines that Suppo
Page 19 and 20: gage_abort Syntax C: void GAGEAPI g
Page 21 and 22: gage_board_abort_capture Syntax C:
Page 23: gage_board_start_capture Syntax C:
Page 27 and 28: gage_calculate_mra_addresses Syntax
Page 29 and 30: gage_calculate_mr_addresses Syntax
Page 31 and 32: gage_capture_mode Syntax C: int16 G
Page 33 and 34: gage_delay_trigger_32 Syntax C: uIn
Page 35 and 36: gage_driver_initialize Syntax C: in
Page 37 and 38: The constant GAGE_MEMORY_SIZE_TEST
Page 39 and 40: gage_force_capture Syntax C: void G
Page 41 and 42: gage_get_driver_info Syntax C: void
Page 43 and 44: gage_get_error_code Syntax C: int16
Page 45 and 46: gage_input_control Syntax C: int16
Page 47 and 48: gage_multiple_record Syntax C: void
Page 49 and 50: gage_need_ram Syntax C: void GAGEAP
Page 51 and 52: gage_power_control Syntax C: int16
Page 53 and 54: #define GAGE_B_L_STATUS_START (GAGE
Page 55 and 56: gage_set_ext_clock_variables Syntax
Page 57 and 58: gage_software_trigger Syntax C: voi
Page 59 and 60: gage_transfer_buffer Syntax C: void
Page 61 and 62: C: offset = gage_transfer_buffer_3(
Page 63 and 64: slope_1 and slope_2 are the trigger
Page 65 and 66: gage_triggered Syntax C: int16 GAGE
Page 67 and 68: gage_acquire_average Syntax C: int3
Page 69 and 70: GAGE_AA_INVALID_SAMPLE_NUM GAGE_AA_
Page 71 and 72: gage_get_boards_found Syntax C: int
Page 73 and 74: gage_get_records Syntax C: int16 GA
Page 75 and 76:
gage_get_trigger_address Syntax C:
Page 77 and 78:
gage_gpib_command Syntax C: int32 G
Page 79 and 80:
gage_mem_read_chan_a Syntax C: int1
Page 81 and 82:
gage_mem_read_dual Syntax C: int16
Page 83 and 84:
gage_multiple_record_acquisitions S
Page 85 and 86:
gage_read_cal_table Syntax C: int16
Page 87 and 88:
gage_set_delay_trigger Syntax C: uI
Page 89 and 90:
gage_set_trigger_depth Syntax C: in
Page 91 and 92:
gage_support_to_text Syntax C: LPST
Page 93 and 94:
gage_trigger_address Syntax C: int3
Page 95 and 96:
Return Value A one is returned if s
Page 97 and 98:
gage_trigger_view_transfer_2 Syntax
Page 99 and 100:
gage_use_cal_table Syntax C: int16
Page 101 and 102:
Appendix A Comparison of Various Da
Page 103 and 104:
the data whose address was specifie
Page 105 and 106:
gage_trigger_view_transfer, gage_tr
Page 107 and 108:
Appendix C Multiple/Independent Mod
Page 109 and 110:
Appendix D Multiple Record Mode Ope
Page 111 and 112:
Illustration of a Multiple Record a
Page 113 and 114:
as long the group number is less th
Page 115 and 116:
Technical Support Gage Applied Tech
show all

CompuScope SDK Manua.. - Egmont Instruments

Create successful ePaper yourself

Delete template?

Save as template?