vc25pro_doc_unaclasses.html

Voice Commnucation Components for Delphi

    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>.onItemRelease: unaListOnItemReleaseEvent;</SPAN><P />
      Fires when list item is needed to be released. NOTE: item[index] could be nil.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>.onItemBeforeRemove: unaListOnItemBeforeRemoveEvent;</SPAN><P />
      Fires when list item is about to be removed from the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>.isObjects: bool;</SPAN><P />
      Specifies whether list contains Delphi objects,
      which should be freed (if autoFree is true) upon removal.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>.isLocked(): bool;</SPAN><P />
      Returns true if list was locked by someone (even same thread).
      Could be used only for checking, like the following: "if (not list.isLocked and list.lock()) then ..."
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>.isEmpty(): bool;</SPAN><P />
      Returns true if there are no items in the list.
      Note, that due to multi-threading issues returned result may be not accurate.
      Use for quick checks only, like status update.
    </TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>(<A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>)</H4><P />
    List of records (pointers).
    <P />In this list memory pointed by items can be freed automatically (depending on autoFree property value).
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>.releaseItem(index: unsigned; doFree: unsigned); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>.create(autoFree: bool = true; const title: string = '');</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>(<A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>)</H4><P /><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.doSetCapacity(value: unsigned); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.notifyBeforeRemove(index: unsigned); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.getId(item: pointer): int64; virtual;</SPAN><P />
      Override this method to provide some implementation of returning the ID of the item.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.add2(item: pointer): unsigned; override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.insert2(index: unsigned; item: pointer): int; override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.setItem2(index: unsigned; item: pointer; doFree: unsigned = 2); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.doReverse(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.doCopyFrom(list: pInt32Array; listSize: int; copyOperation: unaListCopyOpEnum = unaco_add; startIndex: unsigned = 0): int; override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.AfterConstruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.BeforeDestruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.itemById(id: int64; startingIndex: unsigned = 0; timeout: unsigned = INFINITE): pointer;</SPAN><P />
      Returns first item with given ID.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.locateById(id: int64; startingIndex: unsigned = 0): int;</SPAN><P />
      Returns index of first item with given ID.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.removeById(id: int64; doFree: uint = 2): bool;</SPAN><P />
      Removes item with specified ID.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.updateIds(): unsigned;</SPAN><P />
      Assigns new Ids for each item in the list. Returns number of items updated.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaIdList"><SPAN class="class">unaIdList</SPAN></A>.allowDuplicateId: bool;</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaList64"><SPAN class="class">unaList64</SPAN></A>(<A HREF="#class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>)</H4><P />
    List of int64 values.
    <P />In this list memory pointed by items will be freed automatically (depending on autoFree property value).
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.add(item: int64): unsigned;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.insert(index: unsigned; item: int64): unsigned;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.removeItem(item: int64): bool;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.get(index: unsigned): int64;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.setItem(index: unsigned; item: int64);</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.locate(value: int64): int;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaList64"><SPAN class="class">unaList64</SPAN></A>.item[]: int64;</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaObjectList"><SPAN class="class">unaObjectList</SPAN></A>(<A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>)</H4><P />
    List of objects.
    <P />autoFree = true indicates that items will be freed automatically.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaObjectList"><SPAN class="class">unaObjectList</SPAN></A>.create(autoFree: bool = true; const title: string = '');</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaIntfObjectList"><SPAN class="class">unaIntfObjectList</SPAN></A>(<A HREF="#class_unaList"><SPAN class="class">unaList</SPAN></A>)</H4><P />
    List of objects implementing interfaces. Takes care of default ref counting.
    <P />autoFree = true indicates that items will be released automatically.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaIntfObjectList"><SPAN class="class">unaIntfObjectList</SPAN></A>.releaseItem(index: unsigned; doFree: unsigned); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIntfObjectList"><SPAN class="class">unaIntfObjectList</SPAN></A>.add2(item: pointer): unsigned; override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaIntfObjectList"><SPAN class="class">unaIntfObjectList</SPAN></A>.create(autoFree: bool = true; const title: string = '');</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaIntfObjectList"><SPAN class="class">unaIntfObjectList</SPAN></A>.itemAddRef(index: unsigned): int;</SPAN><P />
      Adds one ref to interfaced object stroed in the list. Returns resulting refcount of an item.
    </TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>(<A HREF="#class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>)</H4><P />
    List of strings.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.add(const value: string): unsigned;</SPAN><P />
      Adds new string into list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.get(index: unsigned): string;</SPAN><P />
      Returns a string by its index.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.insert(index: unsigned; const value: string): unsigned;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.locate(const value: string; exact: bool = true): int;</SPAN><P />
      Performs a case sensitive (if exact is true) or not (if exact is false) search.
      Returns string index or -1 if specified string was not found.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.locateValue(const name: string): int;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.setItem(index: unsigned; const item: string);</SPAN><P />
      Changes an item with specifiled index in the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.readFromFile(const fileName: wideString): int;</SPAN><P />
      Replaces content of text with data read from a file.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.text: string;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.names[]: [unknown];</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>.values[]: [unknown];</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>(<A HREF="#class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>)</H4><P />
    List of wide strings.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.add(const value: wideString): unsigned;</SPAN><P />
      Adds new string into list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.get(index: unsigned): wideString;</SPAN><P />
      Returns a string by its index.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.locate(const value: wideString; exact: bool = true): int;</SPAN><P />
      Performs a case sensitive (if exact is true) or not (if exact is false) search.
      Returns string index or -1 if specified string was not found.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.locateValue(const name: wideString): int;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.setItem(index: unsigned; const item: wideString);</SPAN><P />
      Changes an item with specifiled index in the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.readFromFile(const fileName: wideString): int;</SPAN><P />
      Replaces content of text with data read from a file.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.text: wideString;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaWideStringList"><SPAN class="class">unaWideStringList</SPAN></A>.values[]: [unknown];</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>(<A HREF="#class_unaRecordList"><SPAN class="class">unaRecordList</SPAN></A>)</H4><P />