• Home
• Getting Started
• Methods
• Properties
  • DSM_Group_API
  • number
  • DSMX
  • api_aux
  • api_description
  • api_subversion
  • api_version
  • burst_mode
  • chirp1
  • chirp2
  • chirp3
  • Clock_Frequency
  • clock_readback
  • code
  • data_length
  • dds_reset_by_memory
  • delay
  • guard_length
  • is_signature_file_exist
  • loop_count
  • marker_enabled
  • marker_polarity
  • marker_start
  • marker_width
  • memory_depth
  • memory_dump
  • module_id_number
  • RESET_T1
  • RESET_T2
  • RESET_T3
  • slave_mode
  • upage_available
  • user_page
  • user_page_used_count
  • with_guard_page
• Helpful Tips
• Examples

api_description

---

Description

Displays API description.

Syntax

Read

Gets API description.

Example

string apiDescription;
apiDescription = dsm.api_description;

Write

Read-Only

Notes

This property is used to identify the API and is useful when you contact us for support. The Description is only one parameter out of four that distinguishes the API. The other three are the API Version, Sub-version and Auxiliary code. We will need to know all four parameters when you contact us for support.

The description will usually comprises of the release date and copyright.