CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_Fct_SharedDisplay.h
Go to the documentation of this file.
1 //*********************************************************
2 // File: CLC_Fct_SharedDisplay.h
3 // Project: CopperLan CHAILink Client SDK
4 // Version: 1.3
5 // Release Date: 2014/04/15
6 //*********************************************************
7 
8 /********************************************************************
9 Software License Agreement: CHAILink Client source code
10 
11 The software supplied herewith by Klavis Technology (the “Company”) is intended and
12 supplied to you, the Company’s customer, for use solely and exclusively on embedded
13 CopperLan products needing a CHAILink Client.
14  The software is owned by the Company and/or its supplier, and is protected
15  under applicable copyright laws. All rights are reserved. Any use in violation of the
16  foregoing restrictions may subject the user to criminal sanctions under applicable laws,
17 as well as to civil liability for the breach of the terms and conditions of this license.
18 
19 THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS,
20  IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
21  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
22 IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
23 COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
24 OF ANY KIND.
25 ********************************************************************/
26 
27 #ifndef _CLC_FCT_SHAREDDISPLAY_H_
28 #define _CLC_FCT_SHAREDDISPLAY_H_
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
42 
45 #if defined(ENABLE_DEVICE_SHAREDDISPLAY)
46 
54  CPHOBJECT const hSharedDisplay);
55 
61  CPHOBJECT const hSharedDisplay);
62 #endif // defined(ENABLE_DEVICE_SHAREDDISPLAY)
63 
67 
77  CPHOBJECT const hSharedDisplay,
78  CPDEVICEID * const pSourceDevID,
79  SharedDisplayCaps const displayCaps,
80  CPUINT16 const wWidth,
81  CPUINT16 const wHeight);
82 
88  CPHOBJECT const hSharedDisplay);
90 
93 
101  CPHOBJECT const hSharedDisplay,
102  SharedDisplayKeyTypes const type,
103  CPCHAR8 const * const strFromKeyboard );
105 
107 
108 #ifdef __cplusplus
109 }
110 #endif
111 
112 #endif // _CLC_FCT_SHAREDDISPLAY_H_
#define CLC_SDK_API
Definition: CLCm_Platform.h:37
CLC_ErrorCode SharedDisplay_ReleaseSharedDisplay(CPHOBJECT const hSharedDisplay)
Release the shared display.
CLC_ErrorCode
Error code Enumeration. Error codes from 0x01 to 0xFF are related to a CopperLan functions return cod...
Definition: CLCm_Defines.h:469
char CPCHAR8
Character Type (8 bit signed)
Definition: PlatformTypes.h:66
CLC_ErrorCode SharedDisplay_RegisterNotificationHandler(CPHOBJECT const hSharedDisplay)
Register notification handler for a shared display local device.
CLC_ErrorCode SharedDisplay_UnregisterNotificationHandler(CPHOBJECT const hSharedDisplay)
Unregister notification handler for a shared display local device.
CLC_ErrorCode SharedDisplay_Accept(CPHOBJECT const hSharedDisplay, CPDEVICEID *const pSourceDevID, SharedDisplayCaps const displayCaps, CPUINT16 const wWidth, CPUINT16 const wHeight)
Accept a client request.
unsigned short CPUINT16
Word Integer (16 bit unsigned)
Definition: PlatformTypes.h:45
Container structure for Device ID.
Definition: CLC_Types.h:39
CPUINT32 CPHOBJECT
Handle on Object.
Definition: CLCm_Types.h:57
SharedDisplayCaps
Shared display capabilities.
Definition: CLC_Enums.h:2163
CLC_ErrorCode SharedDisplay_SendKey(CPHOBJECT const hSharedDisplay, SharedDisplayKeyTypes const type, CPCHAR8 const *const strFromKeyboard)
Send key or string to the connected client if any.
SharedDisplayKeyTypes
Shared display key types.
Definition: CLC_Enums.h:2194