Dispatch.h

Go to the documentation of this file.

#pragma once

#include <cmp.h>

// Automation interface
// very limited to which variables can be used based on being consumed by automation
// Limitations:
//   Can only use signed integers (INT16 or INT32)
//   Structures can only contain simple data types that are known to automation
//   Typedefs generally have trouble since they might not be picked up in typelib
//
[
    dual,
    oleautomation,
    uuid("6E75C018-2239-4BE2-AE5E-178961D3F5D3"),
    helpstring("Citrix Mobility CMPDispatch Interface")
]
__interface ICMPDispatch: IDispatch
{
    STDMETHODIMP GetButtonTarget([in]CMP_BUTTON_ID button, [out]CMP_BUTTON_TARGET* target,  [out, retval]CMPRESULT *result);
    STDMETHODIMP SetButtonTarget([in]CMP_BUTTON_ID button, [in]CMP_BUTTON_TARGET target, [out, retval]CMPRESULT *result);

    STDMETHODIMP OpenSession([out, retval]CMPRESULT *result);
    STDMETHODIMP IsSessionActive([out, retval]VARIANT_BOOL *sessionActive);
    STDMETHODIMP GetSessionState([out, retval]CMP_SESSION_STATE* sessionState);
    STDMETHODIMP CloseSession([out, retval]CMPRESULT *result);

    STDMETHODIMP GetCapabilityBool([in]CMP_CAP_ID capID,  [in]CMP_KEY_ID keyId, [out]VARIANT_BOOL *keyValue,   [out,retval]CMPRESULT* result);
    STDMETHODIMP GetCapabilityInt16([in]CMP_CAP_ID capID, [in]CMP_KEY_ID keyId, [out]INT16 *keyValue,  [out,retval]CMPRESULT* result);
    STDMETHODIMP GetCapabilityInt32([in]CMP_CAP_ID capID, [in]CMP_KEY_ID keyId, [out]INT32 *keyValue,  [out,retval]CMPRESULT* result);

    STDMETHODIMP IsChannelOpen([out, retval]VARIANT_BOOL *readyState);
    STDMETHODIMP OpenChannel([in]CMP_CHANNEL_FLAGS ChannelFlags, [out, retval]CMPRESULT* result);
    STDMETHODIMP CloseChannel([out, retval]CMPRESULT* result);

    STDMETHODIMP EnableControls([out, retval]CMPRESULT* result);
    STDMETHODIMP DisableControls([out, retval]CMPRESULT* result);
    STDMETHODIMP GetControlsFlags([out]INT16* controlFlags, [out, retval]CMPRESULT* result);

    STDMETHODIMP TakePicture([in]CMP_IMAGE_FORMAT imgType, [in]CMP_UNIQUE_ID imageID, [out, retval]CMPRESULT* result);

    STDMETHODIMP GetPictureState([in]CMP_UNIQUE_ID pictureId, [out]INT32* size, [out]CMP_PICTURE_STATE* pictState, 
                            [out, retval]CMPRESULT* result);
    STDMETHODIMP GetPictureFilename([in]CMP_UNIQUE_ID pictureId, [out]BSTR* filename, [out, retval]CMPRESULT* result);

    STDMETHODIMP RemovePicture([in]CMP_UNIQUE_ID pictureId, [out, retval]CMPRESULT* result);

    STDMETHODIMP GetDevicePropertyBool([in]CMP_DEV_BOOL_PROP_ID   propertyId, [out]VARIANT_BOOL *deviceBool, [out,retval]CMPRESULT* result);
    STDMETHODIMP GetDevicePropertyString([in]CMP_DEV_STRING_PROP_ID propertyId, [out]BSTR *deviceString, [out,retval]CMPRESULT* result);

    STDMETHODIMP GetOrientation([out]CMP_ORIENTATION_DATA* orientationData, [out,retval]CMPRESULT* result);

    STDMETHODIMP SetOrientation([in]CMP_ORIENTATION_POSITION orientation, [in]INT16 orientationFlags, [out,retval]CMPRESULT* result);
    STDMETHODIMP GetScrollMode([out]CMP_SCROLL_MODE* scrollMode, [out,retval]CMPRESULT* result);
    STDMETHODIMP SetScrollMode([in]CMP_SCROLL_MODE scrollMode, [out,retval]CMPRESULT* result);
    STDMETHODIMP SetViewportOrigin([in]CMP_DISPLAY_POINT* pt, [in]INT16 viewportFlags, [out,retval]CMPRESULT* result);
    STDMETHODIMP GetViewportOrigin([in]CMP_DISPLAY_POINT* pt, [out,retval]CMPRESULT* result);

    STDMETHODIMP GetDisplaySettings([out]CMP_DISPLAY_SETTINGS *dispSettings, [out, retval]CMPRESULT* result);

    STDMETHODIMP NotifyUser([in]CMP_UNIQUE_ID notificationId, [in]INT16 notificationFlags, 
                       [in]BSTR notificationText, [out, retval]CMPRESULT* result);

    STDMETHODIMP StartPhoneCall([in]BSTR phoneNumber, [in]CMP_UNIQUE_ID phoneCallId, [out, retval]CMPRESULT* result);
    STDMETHODIMP SendSMS([in]BSTR phoneNumber, [in]CMP_UNIQUE_ID msgID, [in]BSTR SMSText, [out, retval]CMPRESULT* result);

    STDMETHODIMP HideKeyboard([out,retval]CMPRESULT* result);
    STDMETHODIMP ShowKeyboard([in]CMP_KEYBOARD_STATE* kybdState, [out,retval]CMPRESULT* result);
    STDMETHODIMP GetKeyboardState([out]CMP_KEYBOARD_STATE* kybdState, [out, retval]CMPRESULT* result);


    STDMETHODIMP HidePicker([in]CMP_UNIQUE_ID controlID, [out, retval]CMPRESULT* result);
    STDMETHODIMP GetPickerState([in]CMP_UNIQUE_ID controlId, [out]PINT16 pickerState, [out, retval]CMPRESULT* result);

    STDMETHODIMP ShowPicker([in]CMP_UNIQUE_ID controlId, [in]CMP_DISPLAY_RECT *rect, [in]INT32 selectedIndex, 
                            [in, satype("BSTR")]SAFEARRAY **pickerText, [in]BSTR pickerTitle, [out, retval]CMPRESULT* result);

    STDMETHODIMP SetViewport([in]INT16 flags, [in]INT16 zoomFactor, [in]CMP_DISPLAY_RECT* serverViewport,
                             [out,retval]CMPRESULT* result);
    STDMETHODIMP GetViewport([out]INT16* flags, [out]INT16* zoomFactor, [out]CMP_DISPLAY_RECT* serverViewport, 
                             [out]CMP_DISPLAY_RECT* clientViewport, [out,retval]CMPRESULT* result);

    STDMETHODIMP GetChannelState([out, retval]CMP_CHANNEL_STATE* state);

    STDMETHODIMP RegisterCMPProcess([in]DWORD processId, [out, retval]CMPRESULT* result);
    STDMETHODIMP UnregisterCMPProcess([in]DWORD processId, [out, retval]CMPRESULT* result);
    STDMETHODIMP DetectCMPProcess([in]DWORD processId, [out]VARIANT_BOOL* flag, [out,retval]CMPRESULT *result);

    STDMETHODIMP OpenSessionForProcess([in]DWORD processId, [out, retval]CMPRESULT* result);

    STDMETHODIMP CapturePicture([in]CMP_CAPTURE_PICTURE_OPTIONS *options, [out]CMP_UNIQUE_LONG_ID *uniqueId, [out, retval]CMPRESULT* result);
    STDMETHODIMP CaptureVideo([in]CMP_CAPTURE_VIDEO_OPTIONS *options, [out]CMP_UNIQUE_LONG_ID *uniqueId, [out, retval]CMPRESULT* result);
    STDMETHODIMP CaptureAudio([in]CMP_CAPTURE_AUDIO_OPTIONS *options, [out]CMP_UNIQUE_LONG_ID *uniqueId, [out, retval]CMPRESULT* result);
    STDMETHODIMP RemoveCapturedData([in]CMP_UNIQUE_LONG_ID uniqueId, [out, retval]CMPRESULT* result);

    STDMETHODIMP SetSupportedOrientations([in]CMP_SUPPORTED_ORIENTATIONS supportedOrientations, [out,retval]CMPRESULT* result);
    STDMETHODIMP GetSupportedOrientations([out]CMP_SUPPORTED_ORIENTATIONS *supportedOrientations, [out,retval]CMPRESULT* result);
};