cmp.h

Go to the documentation of this file.

#pragma once

// only include the definitions if CMPCOM.h has not been loaded already
#ifndef __cmpcom_h__
#include <cmptypes.h>
#include <cmpcap.h>
#include <cmpenum.h>
#include <cmpflags.h>
#include <cmpstruct.h>
#endif

#include <OleAuto.h>
#include <cmpresult.h>

// everything in this file assumes C naming conventions
#ifdef __cplusplus
extern "C"
{
#endif

// defines

// all of our API are based on standard call, just like WINAPI
#define CMPCALL     __stdcall
#define CMPAPI      CMPCALL
#define CMPEXPORT   __declspec(dllexport)
#define CMPIMPORT   __declspec(dllimport)

#define CMPAPIENTRY CMPEXPORT CMPRESULT CMPCALL

typedef char *UTF8_STRING;

// event handler callback
typedef PVOID CMP_EVENT_CALLBACK;

#define CMP_VERSION_MAJOR       1
#define CMP_VERSION_MINOR       0

#ifdef CMPCOM
[export]
#endif
struct CMP_FILEVERSION
{
    USHORT      Major;
    USHORT      Minor;
    USHORT      Build;
    USHORT      Revision;
};

#ifndef __cplusplus
typedef struct CMP_FILEVERSION CMP_FILEVERSION;
#endif

#ifdef CMPCOM
[export, public]
#endif
typedef struct CMP_VERSION
{
    USHORT          CMPAPI_Major;
    USHORT          CMPAPI_Minor;
    LPCSTR          CMPAPI_BuildDate;

    LPCSTR          CMPAPIDLL_Name;
    CMP_FILEVERSION CMPAPIDLL;

    LPCSTR          CMPCOMDLL_Name;
    CMP_FILEVERSION CMPCOMDLL;

} CMP_VERSION;


/*
 * CMPInitialize - initialize the COM threading model
 */
CMPAPIENTRY CMPInitialize(BOOL MultiThreaded);
CMPAPIENTRY CMPUninitialize();

// Open/Close
CMPAPIENTRY CMPOpen(HANDLE *phCMP);
CMPAPIENTRY CMPClose(HANDLE hCMP);

// Version
CMPAPIENTRY CMPGetAPIVersion(HANDLE hCMP, CMP_VERSION *cmpVersion);
CMPAPIENTRY CMPGetDLLPath(HANDLE hCMP, LPCSTR DLLfilename, LPSTR DLLfilepath, UINT32 pathLength);

// CMP Process
CMPAPIENTRY CMPProcessDetect(HANDLE hCMP, DWORD processId, PBOOL detectFlag);
CMPAPIENTRY CMPRegisterProcess(HANDLE hCMP, DWORD processId);
CMPAPIENTRY CMPUnregisterProcess(HANDLE hCMP, DWORD processId);

// Session
CMPAPIENTRY CMPOpenSession(HANDLE hCMP);
CMPAPIENTRY CMPCloseSession(HANDLE hCMP);
CMPAPIENTRY CMPSetSessionOptionBool(HANDLE hCMP, CMP_SESSION_OPTION option, BOOL value);
CMPAPIENTRY CMPGetSessionOptionBool(HANDLE hCMP, CMP_SESSION_OPTION option, BOOL *value);
CMPAPIENTRY CMPGetSessionState(HANDLE hCMP, CMP_SESSION_STATE* sessionState);

// Button
CMPAPIENTRY CMPGetButtonTarget(HANDLE hCMP, CMP_BUTTON_ID buttonId, CMP_BUTTON_TARGET* buttonTarget);
CMPAPIENTRY CMPSetButtonTarget(HANDLE hCMP, CMP_BUTTON_ID buttonId, CMP_BUTTON_TARGET buttonTarget);

// Camera
CMPAPIENTRY CMPTakePicture(HANDLE hCMP, CMP_UNIQUE_ID pictureId, CMP_IMAGE_FORMAT imageFormat);
CMPAPIENTRY CMPGetPictureFilename(HANDLE hCMP, CMP_UNIQUE_ID pictureId, UTF8_STRING filename, UINT32 bufferLength, PUINT32 returnedLength);
CMPAPIENTRY CMPGetPictureState(HANDLE hCMP, CMP_UNIQUE_ID pictureId, PUINT32 size, CMP_PICTURE_STATE *pictState);
CMPAPIENTRY CMPRemovePicture(HANDLE hCMP, CMP_UNIQUE_ID pictureId);

// Controls
CMPAPIENTRY CMPGetControlsFlags(HANDLE hCMP, PUINT16 controlFlags);
CMPAPIENTRY CMPDisableControls(HANDLE hCMP);
CMPAPIENTRY CMPEnableControls(HANDLE hCMP);

// Device
CMPAPIENTRY CMPGetDevicePropertyBool(HANDLE hCMP, CMP_DEV_BOOL_PROP_ID propertyId, PBOOL value);
CMPAPIENTRY CMPGetDevicePropertyString(HANDLE hCMP, CMP_DEV_STRING_PROP_ID propertyId, UTF8_STRING propertyString, 
                                            UINT32 propertyBufferSize, PUINT32 returnedSize);

// Display
CMPAPIENTRY CMPGetOrientation(HANDLE hCMP, CMP_ORIENTATION_DATA* orientationData);
CMPAPIENTRY CMPSetOrientation(HANDLE hCMP, CMP_ORIENTATION_POSITION orientation, UINT16 orientationFlags);
CMPAPIENTRY CMPGetScrollMode(HANDLE hCMP, CMP_SCROLL_MODE* scrollMode);
CMPAPIENTRY CMPSetScrollMode(HANDLE hCMP, CMP_SCROLL_MODE scrollMode);
CMPAPIENTRY CMPGetDisplaySettings(HANDLE hCMP, CMP_DISPLAY_SETTINGS* dispSettings);
CMPAPIENTRY CMPGetViewportOrigin(HANDLE hCMP, CMP_DISPLAY_POINT* pt);
CMPAPIENTRY CMPSetViewportOrigin(HANDLE hCMP, CMP_DISPLAY_POINT* pt, UINT16 viewportFlags);
CMPAPIENTRY CMPGetViewport(HANDLE hCMP, INT16 *flags, INT16 *zoomFactor, CMP_DISPLAY_RECT* serverViewport, CMP_DISPLAY_RECT *clientViewport);
CMPAPIENTRY CMPSetViewport(HANDLE hCMP, INT16 flags, INT16 zoomFactor, CMP_DISPLAY_RECT* serverViewport);


// Keyboard
CMPAPIENTRY CMPGetKeyboardState(HANDLE hCMP, CMP_KEYBOARD_STATE* kybdState);
CMPAPIENTRY CMPShowKeyboard(HANDLE hCMP, CMP_KEYBOARD_STATE* kybdState);
CMPAPIENTRY CMPHideKeyboard(HANDLE hCMP);

// Message
CMPAPIENTRY CMPSendSMS(HANDLE hCMP, UTF8_STRING phoneNumber, CMP_UNIQUE_ID msgId, UTF8_STRING SMSText);

// Phone
CMPAPIENTRY CMPStartCall(HANDLE hCMP, UTF8_STRING phoneNumber, CMP_UNIQUE_ID callId);

// Picker
CMPAPIENTRY CMPShowPicker(HANDLE hCMP, CMP_UNIQUE_ID controlId, CMP_DISPLAY_RECT* rect, UINT32 selectedIndex,
                          UINT32 listItemsCount, UTF8_STRING listItems, UTF8_STRING title);
CMPAPIENTRY CMPShowPickerUTF16(HANDLE hCMP, CMP_UNIQUE_ID controlId, CMP_DISPLAY_RECT* rect, UINT32 selectedIndex,
                               UINT32 listItemsCount, LPCWSTR listItems, LPCWSTR title);
CMPAPIENTRY CMPHidePicker(HANDLE hCMP, CMP_UNIQUE_ID controlId);
CMPAPIENTRY CMPGetPickerState(HANDLE hCMP, CMP_UNIQUE_ID controlId, PUINT16 pickerState);

// capabilities
CMPAPIENTRY CMPGetCapabilityBool(HANDLE hCMP,   CMP_CAP_ID capID, UINT16 keyId, PBOOL   value);
CMPAPIENTRY CMPGetCapabilityInt16(HANDLE hCMP,  CMP_CAP_ID CapID, UINT16 KeyId, PINT16 Value);
CMPAPIENTRY CMPGetCapabilityUInt16(HANDLE hCMP, CMP_CAP_ID capID, UINT16 keyId, PUINT16 value);
CMPAPIENTRY CMPGetCapabilityInt32(HANDLE hCMP,  CMP_CAP_ID capID, UINT16 keyId, PINT32  value);
CMPAPIENTRY CMPGetCapabilityUInt32(HANDLE hCMP, CMP_CAP_ID capID, UINT16 keyId, PUINT32 value);

// notification
CMPAPIENTRY CMPNotifyUser(HANDLE hCMP, CMP_UNIQUE_ID notificationId, USHORT notificationFlags, UTF8_STRING notificationText);

// channel
CMPAPIENTRY CMPGetChannelState(HANDLE hCMP, CMP_CHANNEL_STATE* state);

// Events
CMPAPIENTRY CMPFilterEvent(HANDLE hCMP, CMP_EVENT_ID eventId, UINT16 filterFlags);

// generic event handler register/unregister
CMPAPIENTRY CMPRegisterForEvent(HANDLE hCMP, CMP_EVENT_ID eventId, CMP_EVENT_CALLBACK eventHandler);
CMPAPIENTRY CMPUnregisterForEvent(HANDLE hCMP, CMP_EVENT_ID eventId, CMP_EVENT_CALLBACK eventHandler);

// Event callbacks
typedef void (CMPCALL *PFN_EVENT_BUTTON_PRESSED) (HANDLE hCMP, CMP_BUTTON_ID buttonId);
typedef void (CMPCALL *PFN_EVENT_DISPLAY_SETTINGS_CHANGED) (HANDLE hCMP, INT16 MetricFlags, INT32 pixelWidth, INT32 pixelHeight,
                                        INT16 colorDepth, INT32 XPixelsPerInch, INT32 YPixelsPerInch,
                                        CMP_ORIENTATION_POSITION orientation, INT32 WidthMilliInches, INT32 HeightMilliInches,
                                        INT32 NormalizedDPI);
typedef void (CMPCALL *PFN_EVENT_ORIENTATION_CHANGED)(HANDLE hCMP, CMPRESULT rc, CMP_ORIENTATION_POSITION deviceOrientation,
                   CMP_ORIENTATION_POSITION appOrientation, UINT16 orientationFlags);
typedef void (CMPCALL *PFN_EVENT_SCROLL_MODE_CHANGED)(HANDLE hCMP, CMPRESULT rc, CMP_SCROLL_MODE scrollMode);
typedef void (CMPCALL *PFN_EVENT_KEYBOARD_STATE_CHANGED)(HANDLE hCMP, CMPRESULT rc, CMP_KEYBOARD_TYPE keyboardType, 
                   INT16 keyboardStateFlags, CMP_KEYBOARD_AUTOCAPS kybdAutoCap, CMP_KEYBOARD_RETURNKEY kybdReturnKey);
typedef void (CMPCALL *PFN_EVENT_VIEWPORT_ORIGIN_CHANGED)(HANDLE hCMP, CMPRESULT rc, INT32 left, INT32 top);
typedef void (CMPCALL *PFN_EVENT_VIEWPORT_CHANGED)(HANDLE hCMP, CMPRESULT rc, INT16 flags, INT16 zoomFactor, 
                                         INT32 x0Server, INT32 y0Server, INT32 x1Server, INT32 y1Server,
                                         INT32 x0Client, INT32 y0Client, INT32 x1Client, INT32 y1Client);
typedef void (CMPCALL *PFN_EVENT_BUTTON_TARGET_CHANGED)(HANDLE hCMP, CMPRESULT rc, CMP_BUTTON_ID buttonId, CMP_BUTTON_TARGET buttonTarget);
typedef void (CMPCALL *PFN_EVENT_CONTROL_STATE_CHANGED)(HANDLE hCMP, CMPRESULT rc, UINT16 controlStateFlags);
typedef void (CMPCALL *PFN_EVENT_SMS_STARTED)(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID SMSId);
typedef void (CMPCALL *PFN_EVENT_PHONE_CALL_STARTED)(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID phoneCallId);
typedef void (CMPCALL *PFN_EVENT_PICKER_CONTROL_STATE_CHANGED)(HANDLE hCMP, CMP_UNIQUE_ID pickerId, INT16 pickerStateFlags, CMPRESULT rc, INT16 selectedIndex);
typedef void (CMPCALL *PFN_EVENT_CAMERA_PICTURE_TAKEN)(HANDLE hCMP, CMPRESULT result, CMP_UNIQUE_ID pictureId, 
                                                       CMP_IMAGE_FORMAT pictureFormat, UINT32 pictureSize, UTF8_STRING filename);
typedef void (CMPCALL *PFN_EVENT_FILTER_CHANGED)(HANDLE hCMP, CMPRESULT rc, CMP_EVENT_ID eventId, INT16 filterFlags);
typedef void (CMPCALL *PFN_EVENT_USER_NOTIFIED)(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID notificationId);
typedef void (CMPCALL *PFN_EVENT_CAMERA_PICTURE_REMOVED)(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID pictureId);
typedef void (CMPCALL *PFN_EVENT_SESSION_STATE_CHANGED)(HANDLE hCMP, CMP_SESSION_STATE state);
typedef void (CMPCALL *PFN_EVENT_CHANNEL_STATE_CHANGED)(HANDLE hCMP, CMP_CHANNEL_STATE state);

// Event prototypes (only for documentation)

void CMPCALL ButtonPressed(HANDLE hCMP, CMP_BUTTON_ID buttonId);

void CMPCALL DisplaySettingsChanged(HANDLE hCMP, INT16 MetricFlags, INT32 pixelWidth, INT32 pixelHeight,
                            INT16 colorDepth, INT32 XPixelsPerInch, INT32 YPixelsPerInch,
                            CMP_ORIENTATION_POSITION orientation, INT32 WidthMilliInches, INT32 HeightMilliInches,
                            INT32 normalizedDPI);

void CMPCALL OrientationChanged(HANDLE hCMP, CMPRESULT rc, CMP_ORIENTATION_POSITION deviceOrientation,
                                CMP_ORIENTATION_POSITION appOrientation, UINT16 orientationFlags);

void CMPCALL ScrollModeChanged(HANDLE hCMP, CMPRESULT rc, CMP_SCROLL_MODE scrollMode);

void CMPCALL KeyboardStateChanged(HANDLE hCMP, CMPRESULT rc, CMP_KEYBOARD_TYPE keyboardType, 
                                  INT16 keyboardStateFlags, CMP_KEYBOARD_AUTOCAPS kybdAutoCap, 
                                  CMP_KEYBOARD_RETURNKEY kybdReturnKey);

void CMPCALL ViewportOriginChanged(HANDLE hCMP, CMPRESULT rc, INT32 left, INT32 top);

void CMPCALL ButtonTargetChanged(HANDLE hCMP, CMPRESULT rc, CMP_BUTTON_ID buttonId, CMP_BUTTON_TARGET buttonTarget);

void CMPCALL ControlStateChanged(HANDLE hCMP, CMPRESULT rc, UINT16 controlStateFlags);

void CMPCALL SMSStarted(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID SMSId);

void CMPCALL PhoneCallStarted(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID phoneCallId);

void CMPCALL PickerControlStateChanged(HANDLE hCMP, CMP_UNIQUE_ID pickerId, INT16 pickerStateFlags, CMPRESULT rc, INT16 selectedIndex);

void CMPCALL PictureTaken(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID pictureId, 
                          CMP_IMAGE_FORMAT pictureFormat, UINT32 pictureSize, UTF8_STRING filename);

void CMPCALL FilterChanged(HANDLE hCMP, CMPRESULT rc, CMP_EVENT_ID eventId, INT16 filterFlags);

void CMPCALL UserNotified(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID notificationId);

void CMPCALL PictureRemoved(HANDLE hCMP, CMPRESULT rc, CMP_UNIQUE_ID pictureId);

void CMPCALL SessionStateChanged(HANDLE hCMP, CMP_SESSION_STATE state);

void CMPCALL ChannelStateChanged(HANDLE hCMP, CMP_CHANNEL_STATE state);


void CMPCALL ViewportChanged(HANDLE hCMP, CMPRESULT rc, INT16 flags, INT16 zoomFactor, 
                             INT32 x0Server, INT32 y0Server, INT32 x1Server, INT32 y1Server,
                             INT32 x0Client, INT32 y0Client, INT32 x1Client, INT32 y1Client);

// conversion routines
CMPAPIENTRY UTF16ToUTF8(LPCWSTR wStr, INT32 wStrLen, UTF8_STRING string, UINT32 bufferSize, UINT32 *stringSize);
CMPAPIENTRY UTF8ToBSTR(UTF8_STRING string, INT32 length, BSTR *bStr);

// multistring
CMPAPIENTRY GetUTF8MultiStringLength(UTF8_STRING str, UINT32* length);
CMPAPIENTRY GetUTF16MultiStringLength(LPCWSTR str, UINT32* length);
CMPAPIENTRY GetUTF16ToUTF8MultiStringLength(LPCWSTR str, UINT32* length);
CMPAPIENTRY UTF8MultiStringToBSTR(UTF8_STRING utf8MultiString, BSTR *bStr);
CMPAPIENTRY UTF16ToUTF8MultiString(LPCWSTR wStr, UTF8_STRING multiString, UINT32 stringBufferSize, UINT32* stringSize);
CMPAPIENTRY BSTRSafearrayToBSTR(SAFEARRAY *psa, BSTR *bstr);

// length
CMPAPIENTRY UTF8ToUTF16Length(UTF8_STRING utf8String, UINT32* length);
CMPAPIENTRY UTF16ToUTF8Length(LPCWSTR wString, UINT32* length);


#ifdef __cplusplus
// end EXTERN "C"
}
#endif