vc25pro_doc_unaclasses.html

Voice Commnucation Components for Delphi

    List of file names.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.create(const path, mask: wideString; includeSubF: bool = false);</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.AfterConstruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.BeforeDestruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.refresh(const path, mask: wideString; includeSubF: bool = false; clearUp: bool = true; subLevel: int = 0): bool;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getFileName(index: int): wideString;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getFileDate(index: int; dateIndex: int): SYSTEMTIME;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getFileSize(index: int): int64;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getSubLevel(index: int): uint;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getAttributes(index: int): uint;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getPath(index: int): wideString;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.getSubPath(index: int): wideString;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.root: wideString;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaFileList"><SPAN class="class">unaFileList</SPAN></A>.mask: wideString;</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>(<A HREF="#class_unaObject"><SPAN class="class">unaObject</SPAN></A>)</H4><P />
    Registry access class.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.create(root: HKEY = HKEY_CURRENT_USER);</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.BeforeDestruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.open(const keyPath: wideString; access: unsigned = KEY_READ): int;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.close();</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.loadKeyNames(list: <A HREF="#class_unaStringList"><SPAN class="class">unaStringList</SPAN></A>): int;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; var buf: pointer): unsigned; overload;</SPAN><P />
      Returns item value stored in Windows registry.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; buf: pointer; size: unsigned): unsigned; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; def: int): int; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; def: unsigned): unsigned; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; const def: string): string; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; const def: wideString): wideString; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.get(const name: wideString; const def: int64): int64; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.setValue(const name: wideString; buf: pointer; size: unsigned; keyType: int): int; overload;</SPAN><P />
      Sets the value of item in Windows registry.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.setValue(const name: wideString; value: int): bool; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.setValue(const name: wideString; value: unsigned): bool; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.setValue(const name: wideString; const value: string): bool; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.setValue(const name: wideString; const value: wideString): bool; overload;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaRegistry"><SPAN class="class">unaRegistry</SPAN></A>.setValue(const name: wideString; const value: int64): bool; overload;</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaThread"><SPAN class="class">unaThread</SPAN></A>(<A HREF="#class_unaObject"><SPAN class="class">unaObject</SPAN></A>)</H4><P />
    This is wrapper class over the Windows threads.
    Refer to MSDN documentation for more information about Windows threads.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.execute(globalIndex: unsigned): int; virtual;</SPAN><P />
      This method will be called when execution starts in a new thread.
      Override this method in your own threads.
      Return value indicates result code of thread execution.
      You must check the shouldStop property periodically in your code.
      When shouldStop is set to true you this function should return as soon as possible.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.grantStart(): bool; virtual;</SPAN><P />
      Called just before execute() method.
      Should return true unless it is not desired to continue the execution of a thread.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.grantStop(): bool; virtual;</SPAN><P />
      Called just before shouldStop property will be set to true.
      Should return true unless it is not desired to stop the thread execution.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.startIn(); virtual;</SPAN><P />
      Called just before execute() method.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.startOut(); virtual;</SPAN><P />
      Called just after execute() method.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.onPause(): bool; virtual;</SPAN><P />
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.onResume(): bool; virtual;</SPAN><P />
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.askStop();</SPAN><P />
      Notifies the thread should be stopped.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.setDefaultStopTimeout(value: unsigned);</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.doSetStatus(value: unaThreadStatus);</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.create(active: bool = false; priority: int = THREAD_PRIORITY_NORMAL; const title: string = '');</SPAN><P />
      Creates new thread if active is true. If active is false thread should be created by calling the start() method.
      priority parameter specifies thread priority.
      When autoFree is true thread class will be freed just after thread execution terminates.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.AfterConstruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.BeforeDestruction(); override;</SPAN><P />
      Destroys the thread. If thread is running, stops it by calling the stop() method.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.start(timeout: unsigned = 10000): bool;</SPAN><P />
      Starts the thread.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.stop(timeout: unsigned = INFINITE; force: bool = false): bool;</SPAN><P />
      Stops the thread.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.pause(): bool;</SPAN><P />
      Suspends thread execution.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.sleep(value: unsigned): bool;</SPAN><P />
      Pauses the thread for specified amount of milliseconds.
      Pause may be interrupted by resume(), start(), wakeUp() and stop() mehtods.
      Returns true if pause was interruped, false otherwise.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.wakeUp();</SPAN><P />
      If thread has entered the sleep() state, wakes the thread up, making the speep() method to return True.
      Otherwise simply sets the internal sleep event to signaled state.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.resume(): bool;</SPAN><P />
      Resumes thread execution.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.getStatus(): unaThreadStatus;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.getHandle(): handle;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.getThreadId(): unsigned;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.enter(timeout: unsigned = 1000): bool;</SPAN><P />
      Enters the gate associated with the thread.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.leave();</SPAN><P />
      Leaves the gate associated with the thread.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.shouldStopThread(globalIndex: unsigned): bool;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.shouldStop: bool;</SPAN><P />
      True when thread is (about to be) stopped.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.priority: int;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>.onExecute: unaThreadOnExecuteMethod;</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>(<A HREF="#class_unaObject"><SPAN class="class">unaObject</SPAN></A>)</H4><P />
    This class manages one or more threads.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.create(master: bool = true);</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">destructor <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.Destroy(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.add(thread: <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>): unsigned;</SPAN><P />
      Inserts new thread into list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.get(index: unsigned): <A HREF="#class_unaThread"><SPAN class="class">unaThread</SPAN></A>;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.remove(index: unsigned);</SPAN><P />
      Removes thread from the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.clear();</SPAN><P />
      Removes all threads from the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.getCount(): unsigned;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.start();</SPAN><P />
      Starts all threads in the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</SPAN></A>.stop(timeout: unsigned = INFINITE): bool;</SPAN><P />
      Stops all threads in the list.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaThreadManager"><SPAN class="class">unaThreadManager</S