windhelplib.html

vxworks相关论文

<p>
<dt>
<b>PATH_DOESNT_EXIST</b>
<dd>
 the specified <i>path</i> does not exist
<p>
</dl>

</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./windHelpLib.html#top">windHelpLib</a></b>

<hr>
<a name="windHelpEntryLookup"></a>
<p align=right>
<a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) :  Tcl Procedures</i></a></p>

</blockquote><h1>windHelpEntryLookup</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>windHelpEntryLookup</strong> - gets the entry number in entry names list</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
windHelpEntryLookup <i>rule</i> <i>entryPattern</i> <i>entryNameList</i>
<p>
</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This procedure looks up for the help entry value, and selects the closer
help topic index (alphabeticaly speaking).
<p>
<i>rule</i> should be set to either <b>-exact</b> or to <b>-regexp</b>.
<p>
If set to <b>-exact</b>, then the <i>entryPattern</i> must be the exact match in
<i>entryNameList</i>
<p>
If set to <b>-regexp</b>, lookup is done through a regexp that begins with the
given <i>entryPattern</i>, and then, any other character. The first occurrence is
then returned.
<p>

<p>
</blockquote><h4>PARAMETERS</h4><blockquote><p>
<table>
<tr valign=top>
<td align=left><b>rule</b> </td><td align=left> - </td><td align=left> the rule to lookup for <i>entryPattern</i> pattern</tr>
<tr valign=top>
<td align=left><b>entryPattern</b> </td><td align=left> - </td><td align=left> the help pattern to look for in <i>entryNameList</i></tr>
<tr valign=top>
<td align=left><b>entryNameList</b> </td><td align=left> - </td><td align=left> list of entry names in which to look for <i>entryPattern</i>  </tr>
<tr valign=top>
<td align=left></tr>
</tr>

</table>

<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
the index of the designed entry.
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./windHelpLib.html#top">windHelpLib</a></b>

<hr>
<a name="windHelpIndexGet"></a>
<p align=right>
<a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) :  Tcl Procedures</i></a></p>

</blockquote><h1>windHelpIndexGet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>windHelpIndexGet</strong> - gets the current complete help index</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
windHelpIndexGet [<i>inDir</i>]
<p>
</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This procedure just reads the <i>inDir</i>/INDEX.WRS file in order to have a quick
and complete access to the WRS reference help index.
<p>
The returned list is a list of help entries with the following format :<br>
&nbsp;&nbsp;{&nbsp;{entryName}&nbsp;{shortDescription}&nbsp;{entryLink}&nbsp;{bookName}&nbsp;{chapterName}&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{category}&nbsp;}
<p>
<dl>
<dt>
<b>entryName</b>
<dd>
This is the name of the help entry.
<dt>
<b>shortDescription</b>
<dd>
The help entry short description. Some few words to describe the entry and its
use.
<dt>
<b>entryLink</b>
<dd>
The help entry html link. This value can directly be used through a call to
<b><a href="./windHelpLib.html#windHelpDisplay">windHelpDisplay</a></b>.
<dt>
<b>bookName</b>
<dd>
The book name the help entry belongs to.
<dt>
<b>chapterName</b>
<dd>
The chapter name the help entry belongs to.
<dt>
<b>category</b>
<dd>
This parameter is to differenciate several help entries that could have the
same name (for example, <b><a href="../../vxworks/bsp/ads360/sysLib.html#top" >sysLib</a></b> for several BSPs)
</dl>

</blockquote><h4>FILES</h4><blockquote><p>
<i>inDir</i>/INDEX.WRS : this file is generated when the <b><a href="./windHelpLib.html#windHelpIndexGet">windHelpIndexGet</a></b>
procedure is called and doesn't find the INDEX.WRS file.
<p>

<p>
</blockquote><h4>PARAMETERS</h4><blockquote><p>
<table>
<tr valign=top>
<td align=left><b>inDir</b> </td><td align=left> - </td><td align=left> the directory where to read / write the INDEX.WRS file  </tr>
<tr valign=top>
<td align=left></tr>
</tr>

</table>

<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
the list of available help entries or {} if INDEX.WRS is not readable
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./windHelpLib.html#top">windHelpLib</a></b>

<hr>
<a name="windHelpLinkGet"></a>
<p align=right>
<a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) :  Tcl Procedures</i></a></p>

</blockquote><h1>windHelpLinkGet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>windHelpLinkGet</strong> - gets the <i>helpTopic</i> hyper link</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
windHelpLinkGet <i>rule</i> <i>helpTopic</i> [<i>keyWords</i>]
<p>
</blockquote><h4>DESCRIPTION</h4><blockquote><p>
According to the <i>rule</i> parameter, this routine gets the list of hyperlinks
the <i>helpTopic</i> refers to.
<p>
If <i>rule</i> is set to <b>-name</b>, the result should be empty or unique. If set to
<b>-desc</b>, it returns all the hyperlinks that have descriptions matching
<i>helpTopic</i>
<p>

<p>
</blockquote><h4>PARAMETERS</h4><blockquote><p>
<table>
<tr valign=top>
<td align=left><b>rule</b> </td><td align=left> - </td><td align=left> retreiving rule</tr>
<tr valign=top>
<td align=left><b>helpTopic</b> </td><td align=left> - </td><td align=left> the help topic to look for</tr>
<tr valign=top>
<td align=left><b>keyword</b> </td><td align=left> - </td><td align=left> a pipe separated list of kewords to look for in order to make the #             help research more precise.  </tr>
<tr valign=top>
<td align=left></tr>
</tr>

</table>

<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The list of links or {} if no links found
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./windHelpLib.html#top">windHelpLib</a></b>

<hr>
<a name="windHelpListGet"></a>
<p align=right>
<a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) :  Tcl Procedures</i></a></p>

</blockquote><h1>windHelpListGet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>windHelpListGet</strong> - gets the list of help entries</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
windHelpListGet [<i>type</i>]
<p>
</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine returns the list of help entries according to the <i>type</i>
parameter. This allow to get a list of the entries <b>name</b> / <b>link</b> / <b>desc</b> or
<b>all</b> of them. If <i>type</i> is set to <b>all</b>, then a list of help entries is
returned. Those help entries are made of : name, description, extracted link,
book name, chapter name and category name. Default type is set to <b>all</b>.
<p>

<p>
</blockquote><h4>PARAMETERS</h4><blockquote><p>
<table>
<tr valign=top>
<td align=left><b>type</b> </td><td align=left> - </td><td align=left> the returned help entry type [desc </td><td align=left> link </td><td align=left> name </td><td align=left> all]  </tr>
<tr valign=top>
<td align=left></tr>
</tr>

</table>

<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The list of asked type(s) or {} if none
<p>
</blockquote><h4>ERRORS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./windHelpLib.html#top">windHelpLib</a></b>

</body>
</html>