Jump to content

UniDestroyKeyboard: Difference between revisions

From EDM2
No edit summary
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== UniDestroyKeyboard ==
Close the keyboard reference.
; UniDestroyKeyboard(keyboardHndl) : Close the keyboard reference.
 
=== Syntax ===
UniDestroyKeyboard(keyboardHndl);


=== Parameters ===
=== Parameters ===
; keyboardHndl - [[OS2 API:DataType:KHAND|KHAND]] - input : The key board handle received from [[OS2_API:UniCreateKeyboard|UniCreateKeyboard]].
;keyboardHndl - [[KHAND]] - input : The key board handle received from [[UniCreateKeyboard]].


=== Constants ===
=== Constants ===
Line 10: Line 12:
=== Returns ===
=== Returns ===
An integer with values of:
An integer with values of:
* [[OS2 API:Unicode:error#ULS_BADHANDLE|ULS_BADHANDLE]]
* [[Unicode Errors#ULS_BADHANDLE|ULS_BADHANDLE]]
* [[OS2 API:Unicode:error#ULS_NOOP|ULS_NOOP]]
* [[Unicode Errors#ULS_NOOP|ULS_NOOP]]
* [[OS2 API:Unicode:error#ULS_SUCCESS|ULS_SUCCESS]]
* [[Unicode Errors#ULS_SUCCESS|ULS_SUCCESS]]
 
=== Module ===
 
=== Define (C/C++) ===


=== Export name/Ordinal ===
=== Calling Convention ===
 
=== Calling conversion ===
[[Cdecl32]]
[[Cdecl32]]


=== Example Code ===
=== Example Code ===
  [[OS2 API:DataType:KHAND|KHAND]]   keyboardHndl;
  KHAND  keyboardHndl;
  integer rc;
  integer rc;
  ...
  ...
Line 31: Line 27:


=== Related Functions ===
=== Related Functions ===
[[OS2 API:UniCreateKeyboard|UniCreateKeyboard]]
*[[UniCreateKeyboard]]
[[OS2 API:UniQueryKeyboard|UniQueryKeyboard]]
*[[UniQueryKeyboard]]


=== Notes ===
=== Notes ===
[[OS2_API:UniDestroyKeyboard|UniDestroyKeyboard]] closes the keyboard handle and decrements the use count. When the use count is zero, the keyboard handle is closed.
'''UniDestroyKeyboard''' closes the keyboard handle and decrements the use count. When the use count is zero, the keyboard handle is closed.


=== OS Version Introduced ===
=== OS Version Introduced ===
OS/2 Warp
OS/2 Warp


 
[[Category:Uni]]
[[OS2_API | Back to OS/2 API]]
 
 
[[Category:The OS/2 API Project]]

Latest revision as of 18:54, 26 July 2017

Close the keyboard reference.

Syntax

UniDestroyKeyboard(keyboardHndl);

Parameters

keyboardHndl - KHAND - input
The key board handle received from UniCreateKeyboard.

Constants

None

Returns

An integer with values of:

Calling Convention

Cdecl32

Example Code

KHAND   keyboardHndl;
integer rc;
...
rc = UniDestroyKeyboard(keyboardHndl);
...

Related Functions

Notes

UniDestroyKeyboard closes the keyboard handle and decrements the use count. When the use count is zero, the keyboard handle is closed.

OS Version Introduced

OS/2 Warp