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

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

WINHLLAPI LANGUAGE REFERENCE<br />

Windows Environment Extensions<br />

In addition to <strong>the</strong> above-cited functions based on <strong>the</strong> EHLLAPI st<strong>and</strong>ard, WinHLLAPI<br />

provides several extensions for <strong>the</strong> Windows environment. These collateral<br />

functions, l<strong>is</strong>ted below, <strong>are</strong> described more fully at <strong>the</strong> end of th<strong>is</strong> document.<br />

WINHLLAPISTARTUP( ) – REQUIRED BEFORE ANY OTHER WINHLLAPI CALLS.<br />

WinHLLAPICleanup( ) – Required at <strong>the</strong> close of WinHLLAPI activity.<br />

WinHLLAPIAsync( )<br />

WINHLLAPICANCELASYNCREQUEST( )<br />

What information <strong>is</strong> provided for each<br />

function?<br />

For each WinHLLAPI function, <strong>the</strong> following information <strong>is</strong> presented:<br />

• The function number toge<strong>the</strong>r with its formal name,<br />

• Brief description of <strong>the</strong> function purpose,<br />

• Prerequ<strong>is</strong>ites<br />

• Applicable session parameters<br />

• Call parameters<br />

• Return parameters<br />

• Notes<br />

Prerequ<strong>is</strong>ites<br />

Many WinHLLAPI functions require ano<strong>the</strong>r function to be called <strong>and</strong> successfully<br />

completed before <strong>the</strong> desired call <strong>is</strong> <strong>is</strong>sued. If <strong>the</strong> prerequ<strong>is</strong>ites <strong>are</strong> not sat<strong>is</strong>fied, an<br />

error code <strong>is</strong> returned. If None appears, no prerequ<strong>is</strong>ite calls <strong>are</strong> necessary.<br />

Applicable session parameters<br />

Function 9, “Set Session Parameters,” allows an application program to set optional<br />

WinHLLAPI features, or session parameters. Th<strong>is</strong> section indicates whe<strong>the</strong>r any<br />

session parameters affect th<strong>is</strong> function <strong>and</strong>, if so l<strong>is</strong>ts <strong>the</strong> applicable parameters <strong>and</strong><br />

how <strong>the</strong>y affect <strong>the</strong> function. If <strong>the</strong> function <strong>is</strong> not affected by any session<br />

parameters, None appears.<br />

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

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

Saved successfully!

Ooh no, something went wrong!