BASEstar Classic Application Programming Interface Reference Guide

*HyperReader

CONTENTS

  Title Page

  Copyright Page

  Preface

  1      Introduction
    1.1 Language Bindings
      1.1.1      Data Types
      1.1.2      Returns and Exceptions
      1.1.3      Naming Conventions
      1.1.4      C Language Binding Include Files
      1.1.5      Itemlists
      1.1.6      C Time
    1.2 Document Format

  2      BASEstar Callable Services

  bcc_accept_circuit

  bcc_access_msgport

  bcc_add_extern_map_element

  bcc_add_structure_field

  bcc_add_to_group

  bcc_add_to_group_a

  bcc_bcc

  bcc_cancel_receive

  bcc_cancel_value

  bcc_compile_point_name

  bcc_connect_circuit

  bcc_copy_value

  bcc_create_circuit_cluster

  bcc_create_extern_map

  bcc_create_group

  bcc_create_msg

  bcc_create_msgport

  bcc_create_named_msgport

  bcc_create_point

  bcc_create_structure

  bcc_create_user

  bcc_deaccess_msgport

  bcc_delete_extern_map

  bcc_delete_group

  bcc_delete_msg

  bcc_delete_msgport

  bcc_delete_point

  bcc_delete_structure

  bcc_delete_user

  bcc_disconnect_circuit

  bcc_export_data

  bcc_get_connect_data

  bcc_get_extern_map_element_info

  bcc_get_extern_map_info

  bcc_get_field_value

  bcc_get_group_info

  bcc_get_group_list

  bcc_get_history

  bcc_get_member_list

  bcc_get_msg_info

  bcc_get_msgport_info

  bcc_get_msgsec_info

  bcc_get_namsrv_info

  bcc_get_parameter

  bcc_get_point_info

  bcc_get_point_reference

  bcc_get_status

  bcc_get_structure_field_info

  bcc_get_structure_info

  bcc_get_structure_reference

  bcc_get_system_info

  bcc_get_text

  bcc_get_text_dx

  bcc_get_user_info

  bcc_get_value

  bcc_log_event

  bcc_ls_add_compile_point

  bcc_ls_add_get_value

  bcc_ls_add_put_value

  bcc_ls_compile_point

  bcc_ls_get_value

  bcc_ls_put_value

  bcc_parse_log_event

  bcc_parse_notification_msg

  bcc_put_extern_map_info

  bcc_put_field_value

  bcc_put_group_info

  bcc_put_point_info

  bcc_put_status

  bcc_put_structure_info

  bcc_put_system_info

  bcc_put_user_info

  bcc_put_value

  bcc_receive_msg

  bcc_receive_msg_a

  bcc_reject_circuit

  bcc_release_context

  bcc_remove_extern_map_element

  bcc_remove_from_group

  bcc_remove_from_group_a

  bcc_remove_status

  bcc_remove_structure_field

  bcc_request_value_msg

  bcc_send_msg

  bcc_send_msg_a

  bcc_start_process

  bcc_sync_add_to_list

  bcc_sync_adjust_quorum

  bcc_sync_cancel_wait

  bcc_sync_create_element

  bcc_sync_delete_element

  bcc_sync_get_id

  bcc_sync_get_name

  bcc_sync_read_element

  bcc_sync_release_semaphore

  bcc_sync_remove_from_list

  bcc_sync_trigger_event

  bcc_sync_wait

  bcc_sync_wait_a

  3      BASEstar Device Connection Management Callable Services

  ilan_access_device

  ilan_allocate_device

  ilan_allocate_device_a

  ilan_cancel

  ilan_cancel_a

  ilan_create_device

  ilan_create_point

  ilan_create_pollset

  ilan_dcm

  ilan_deaccess_device

  ilan_deallocate_device

  ilan_deallocate_device_a

  ilan_delete_device

  ilan_delete_file

  ilan_delete_file_a

  ilan_delete_point

  ilan_delete_pollset

  ilan_device_directory

  ilan_device_specific

  ilan_device_specific_a

  ilan_download_file

  ilan_download_file_a

  ilan_get_data

  ilan_get_data_list

  ilan_get_device_info

  ilan_get_point_info

  ilan_get_pollset_info

  ilan_get_pollset_members

  ilan_loop_device

  ilan_loop_device_a

  ilan_parse_notification_msg

  ilan_put_data

  ilan_put_device_info

  ilan_put_point_info

  ilan_put_pollset_info

  ilan_read_data

  ilan_read_data_a

  ilan_read_device_status

  ilan_read_device_status_a

  ilan_select

  ilan_select_a

  ilan_start_device

  ilan_start_device_a

  ilan_stop_device

  ilan_stop_device_a

  ilan_trigger_pollset

  ilan_upload_file

  ilan_upload_file_a

  ilan_write_data

  ilan_write_data_a

  A BASEstar Message Codes

  B BASEstar Data Formats

  C Device Connection Management Data Formats

  D Creating Connections Between Logical Points and Physical Points

  E Compatibility of BASEstar Data Formats

  F Conversions of Connected Logical Points

  G Internal Conversion of Data Types
    G.1 Point Map Conversions

  H BASEstar Messages
    H.1 Format
    H.2 Severity Levels
    H.3 Messages

  I Device Connection Management Messages
    I.1 Format
    I.2 Severity Levels
    I.3 Messages

  J Obsolete BASEstar Services

  K C Code Example

  L Related Source Files