25.10.2014 Views

are registered trademarks, the Attachmate logo is a trademark and

are registered trademarks, the Attachmate logo is a trademark and

are registered trademarks, the Attachmate logo is a trademark and

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

WINHLLAPI LANGUAGE REFERENCE<br />

For Function 51, “Get Key,” TWAIT does not return control to <strong>the</strong> WinHLLAPI client<br />

application program until it has intercepted a key (a normal or AID key, based on <strong>the</strong><br />

option code specified under Function 50, “Start Keystroke Intercept” ).<br />

LWAIT<br />

For Function 4, “Wait,” LWAIT waits until XCLOCK / XSYSTEM clears. Th<strong>is</strong> option <strong>is</strong><br />

not recommended because XSYSTEM or permanent XCLOCK will prevent control<br />

being returned to <strong>the</strong> application.<br />

For Function 51, “Get Key,” LWAIT does not return control to your application until it<br />

has intercepted a key. The intercepted key could be a normal or AID key, based on<br />

<strong>the</strong> option specified under Function 50, “Start Keystroke Intercept.”<br />

NWAIT<br />

For Function 4, “Wait,” NWAIT checks status <strong>and</strong> returns immediately (no wait).<br />

For Function 51, “Get Key,” NWAIT returns code 25 (keystroke not available) if<br />

nothing matching <strong>the</strong> option specified under Function 50, “Start Keystroke<br />

Intercept,” <strong>is</strong> queued.<br />

Return parameters<br />

Parameters accepted<br />

Function replaces <strong>the</strong> value of call parameter Data length with <strong>the</strong> number of session<br />

parameters that were set.<br />

Result code<br />

Function replaces <strong>the</strong> value of call parameter PS position with one of <strong>the</strong> following<br />

codes:<br />

Code<br />

Description<br />

0 The function was successful.<br />

2 One or more parameter names were not recognized; all recognized<br />

parameters were accepted.<br />

9 A system error occurred.<br />

Example<br />

/* Set session parameters */<br />

WORD HllFunc = 9;<br />

char HllDataStr[20];<br />

strcpy (HllDataStr,"SRCHFROM,SRCHFRWD");<br />

/* Length of parameter string */<br />

WORD HllDataLgth = 17;<br />

WORD PsPos;<br />

WinHLLAPI(&HllFunc, HllDataStr, &HllDataLgth, &PsPos);<br />

Prep<strong>are</strong>d by <strong>Attachmate</strong> Technical Support 35

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!