Mobile SDK for Windows Apps2.0
Transforming Windows apps into Mobile apps
ICMPDispatch Struct Reference

#include <Dispatch.h>

Inherited by CitrixMobile.

List of all members.

Public Member Functions

STDMETHODIMP GetButtonTarget ([in]CMP_BUTTON_ID button,[out]CMP_BUTTON_TARGET *target,[out, retval]CMPRESULT *result)
 Get the current button target (host of client).
STDMETHODIMP SetButtonTarget ([in]CMP_BUTTON_ID button,[in]CMP_BUTTON_TARGET target,[out, retval]CMPRESULT *result)
 Set the target for pressing a button.
STDMETHODIMP OpenSession ([out, retval]CMPRESULT *result)
 Open a session between the application and the mobile device.
STDMETHODIMP IsSessionActive ([out, retval]VARIANT_BOOL *sessionActive)
 Determine if there is an active session object which is available.
STDMETHODIMP GetSessionState ([out, retval]CMP_SESSION_STATE *sessionState)
 Get the current state of the session.
STDMETHODIMP CloseSession ([out, retval]CMPRESULT *result)
 Close the session between the application and the mobile device.
STDMETHODIMP GetCapabilityBool ([in]CMP_CAP_ID capID,[in]CMP_KEY_ID keyId,[out]VARIANT_BOOL *keyValue,[out, retval]CMPRESULT *result)
 Get capability boolean value.
STDMETHODIMP GetCapabilityInt16 ([in]CMP_CAP_ID capID,[in]CMP_KEY_ID keyId,[out]INT16 *keyValue,[out, retval]CMPRESULT *result)
 Get capability integer 16-bit value.
STDMETHODIMP GetCapabilityInt32 ([in]CMP_CAP_ID capID,[in]CMP_KEY_ID keyId,[out]INT32 *keyValue,[out, retval]CMPRESULT *result)
 Get capability integer 32-bit value.
STDMETHODIMP IsChannelOpen ([out, retval]VARIANT_BOOL *readyState)
 Is virtual channel open.
STDMETHODIMP OpenChannel ([in]CMP_CHANNEL_FLAGS ChannelFlags,[out, retval]CMPRESULT *result)
 Open the MRVC virtual channel.
STDMETHODIMP CloseChannel ([out, retval]CMPRESULT *result)
 Close the link between the application and the service.
STDMETHODIMP EnableControls ([out, retval]CMPRESULT *result)
 Enable the Receiver Controls for use.
STDMETHODIMP DisableControls ([out, retval]CMPRESULT *result)
 Disable the Receiver Controls from being used.
STDMETHODIMP GetControlsFlags ([out]INT16 *controlFlags,[out, retval]CMPRESULT *result)
 Get the current receiver controls flags.
STDMETHODIMP TakePicture ([in]CMP_IMAGE_FORMAT imgType,[in]CMP_UNIQUE_ID imageID,[out, retval]CMPRESULT *result)
 Take a picture.
STDMETHODIMP GetPictureState ([in]CMP_UNIQUE_ID pictureId,[out]INT32 *size,[out]CMP_PICTURE_STATE *pictState,[out, retval]CMPRESULT *result)
 Get the current picture state based on unique Id.
STDMETHODIMP GetPictureFilename ([in]CMP_UNIQUE_ID pictureId,[out]BSTR *filename,[out, retval]CMPRESULT *result)
 Get the picture filename from the mobile device.
STDMETHODIMP RemovePicture ([in]CMP_UNIQUE_ID pictureId,[out, retval]CMPRESULT *result)
 Remove the picture on the mobile device.
STDMETHODIMP GetDevicePropertyBool ([in]CMP_DEV_BOOL_PROP_ID propertyId,[out]VARIANT_BOOL *deviceBool,[out, retval]CMPRESULT *result)
 Get a boolean mobile device property setting.
STDMETHODIMP GetDevicePropertyString ([in]CMP_DEV_STRING_PROP_ID propertyId,[out]BSTR *deviceString,[out, retval]CMPRESULT *result)
 Get a string mobile device property setting.
STDMETHODIMP GetOrientation ([out]CMP_ORIENTATION_DATA *orientationData,[out, retval]CMPRESULT *result)
 Get current orientation data.
STDMETHODIMP SetOrientation ([in]CMP_ORIENTATION_POSITION orientation,[in]INT16 orientationFlags,[out, retval]CMPRESULT *result)
 Set the application orientation.
STDMETHODIMP GetScrollMode ([out]CMP_SCROLL_MODE *scrollMode,[out, retval]CMPRESULT *result)
 Get current scroll mode.
STDMETHODIMP SetScrollMode ([in]CMP_SCROLL_MODE scrollMode,[out, retval]CMPRESULT *result)
 Set the scroll mode from the mobile device.
STDMETHODIMP SetViewportOrigin ([in]CMP_DISPLAY_POINT *pt,[in]INT16 viewportFlags,[out, retval]CMPRESULT *result)
 Set the origin of the Citrix Receiver viewport.
STDMETHODIMP GetViewportOrigin ([in]CMP_DISPLAY_POINT *pt,[out, retval]CMPRESULT *result)
 Get the origin of the Citrix Receiver viewport.
STDMETHODIMP GetDisplaySettings ([out]CMP_DISPLAY_SETTINGS *dispSettings,[out, retval]CMPRESULT *result)
 Get the current display settings for the mobile device.
STDMETHODIMP NotifyUser ([in]CMP_UNIQUE_ID notificationId,[in]INT16 notificationFlags,[in]BSTR notificationText,[out, retval]CMPRESULT *result)
 Notify the user of an event using a combination of vibration, sound, light, and text.
STDMETHODIMP StartPhoneCall ([in]BSTR phoneNumber,[in]CMP_UNIQUE_ID phoneCallId,[out, retval]CMPRESULT *result)
 Start a phone call.
STDMETHODIMP SendSMS ([in]BSTR phoneNumber,[in]CMP_UNIQUE_ID msgID,[in]BSTR SMSText,[out, retval]CMPRESULT *result)
STDMETHODIMP HideKeyboard ([out, retval]CMPRESULT *result)
 Hide the display keyboard.
STDMETHODIMP ShowKeyboard ([in]CMP_KEYBOARD_STATE *kybdState,[out, retval]CMPRESULT *result)
 Show the display keyboard with the given properties.
STDMETHODIMP GetKeyboardState ([out]CMP_KEYBOARD_STATE *kybdState,[out, retval]CMPRESULT *result)
 Get the current keyboard state.
STDMETHODIMP HidePicker ([in]CMP_UNIQUE_ID controlID,[out, retval]CMPRESULT *result)
 Hide a picker control that is currently being displayed.
STDMETHODIMP GetPickerState ([in]CMP_UNIQUE_ID controlId,[out]PINT16 pickerState,[out, retval]CMPRESULT *result)
 Get the picker control state on the mobile device.
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)
 Show the picker control on the mobile device. This version is compatible with automation.
STDMETHODIMP SetViewport ([in]INT16 flags,[in]INT16 zoomFactor,[in]CMP_DISPLAY_RECT *serverViewport,[out, retval]CMPRESULT *result)
 Set the viewport for the mobile device.
STDMETHODIMP GetViewport ([out]INT16 *flags,[out]INT16 *zoomFactor,[out]CMP_DISPLAY_RECT *serverViewport,[out]CMP_DISPLAY_RECT *clientViewport,[out, retval]CMPRESULT *result)
 Get the current viewport for the mobile device.
STDMETHODIMP GetChannelState ([out, retval]CMP_CHANNEL_STATE *state)
 Get the current state of the channel.
STDMETHODIMP RegisterCMPProcess ([in]DWORD processId,[out, retval]CMPRESULT *result)
 Register the process as belonging to CMP.
STDMETHODIMP UnregisterCMPProcess ([in]DWORD processId,[out, retval]CMPRESULT *result)
 Unregister the process as belonging to CMP.
STDMETHODIMP DetectCMPProcess ([in]DWORD processId,[out]VARIANT_BOOL *flag,[out, retval]CMPRESULT *result)
 Detect if a process is using CMP.
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)

Member Function Documentation

STDMETHODIMP ICMPDispatch::CaptureAudio ( [in] CMP_CAPTURE_AUDIO_OPTIONS options,
[out] CMP_UNIQUE_LONG_ID uniqueId,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::CapturePicture ( [in] CMP_CAPTURE_PICTURE_OPTIONS options,
[out] CMP_UNIQUE_LONG_ID uniqueId,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::CaptureVideo ( [in] CMP_CAPTURE_VIDEO_OPTIONS options,
[out] CMP_UNIQUE_LONG_ID uniqueId,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::CloseChannel ( [out, retval] CMPRESULT result)

Close the link between the application and the service.

Parameters:
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::CloseSession ( [out, retval] CMPRESULT result)

Close the session between the application and the mobile device.

Parameters:
resultresult of CMP call
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::DetectCMPProcess ( [in] DWORD  processId,
[out] VARIANT_BOOL *  detectFlag,
[out,retval] CMPRESULT result 
)

Detect if a process is using CMP.

During the development of CMP, it became necessary to know whether or not a process was hosting the CMP object. This was needed to avoid the automatic XenApp code from interfering with the process that already handles things using the CMP API.

Parameters:
processIdprocess Id of the process to be checked
detectFlagindicates if it is using CMP (TRUE) or it is a legacy application (FALSE)
resultreturned CMPRESULT
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::DisableControls ( [out, retval] CMPRESULT result)

Disable the Receiver Controls from being used.

Parameters:
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::EnableControls ( [out, retval] CMPRESULT result)

Enable the Receiver Controls for use.

Parameters:
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetButtonTarget ( [in] CMP_BUTTON_ID  button,
[out] CMP_BUTTON_TARGET target,
[out, retval] CMPRESULT result 
)

Get the current button target (host of client).

Get the current destination for button events. The target will either be the server or the client. The host application will be notified of button events if it is the destination. Otherwise the client (mobile device) will handle it like normal.

Parameters:
button- selected button (home, search, back, etc.)
target- destination for events (server or client)
result- returned CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetCapabilityBool ( [in] CMP_CAP_ID  capId,
[in] CMP_KEY_ID  keyId,
[out] VARIANT_BOOL *  keyValue,
[out,retval] CMPRESULT result 
)

Get capability boolean value.

Return capability setting to the caller. This call only returns VARIANT_BOOL which is a short. The reason for using this instead of BOOL is that VARIANT_BOOL is compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:
capId- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId- key selected (e.g. CAP_INPUT_ENABLE)
keyValue- returned value (boolean)
result- CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetCapabilityInt16 ( [in] CMP_CAP_ID  capId,
[in] CMP_KEY_ID  keyId,
[out] INT16 *  keyValue,
[out,retval] CMPRESULT result 
)

Get capability integer 16-bit value.

Return capability setting to the caller. This call only returns INT16. This call is compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:
capId- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId- key selected (e.g. CAP_INPUT_ENABLE)
keyValue- returned value (INT16)
result- returned CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetCapabilityInt32 ( [in] CMP_CAP_ID  capId,
[in] CMP_KEY_ID  keyId,
[out] INT32 *  keyValue,
[out,retval] CMPRESULT result 
)

Get capability integer 32-bit value.

Return capability setting to the caller. This call only returns INT32. This call is compatible with automation. The capability id along with the key id determines which setting we are trying to get. Internally in the MRVC User mode code, it maps the request to the actual capability data. This API strategy is easier than having to implement one call per capability setting.

Parameters:
capId- capability selected (e.g. CAPID_INPUT) CMP_CAP_ID
keyId- key selected (e.g. CAP_INPUT_ENABLE)
keyValue- returned value (INT32)
result- returned CMP-based result
Returns:
HRESULT
STDMETHODIMP ICMPDispatch::GetChannelState ( [out, retval] CMP_CHANNEL_STATE state)

Get the current state of the channel.

Parameters:
state- returned channel state CMP_CHANNEL_STATE
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetControlsFlags ( [out] INT16 *  controlFlags,
[out, retval] CMPRESULT result 
)

Get the current receiver controls flags.

Parameters:
controlFlags- returned flags for controls
result- result of the operation
Returns:
HRESULT
STDMETHODIMP ICMPDispatch::GetDevicePropertyBool ( [in] CMP_DEV_BOOL_PROP_ID  propertyId,
[out] VARIANT_BOOL *  value,
[out,retval] CMPRESULT result 
)

Get a boolean mobile device property setting.

This is useful for determining more granular features on the device and also an easy way to publish flexible information.

Parameters:
propertyId- unique property Id to get
value- returned value for property
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetDevicePropertyString ( [in] CMP_DEV_STRING_PROP_ID  propertyId,
[out] BSTR *  string,
[out,retval] CMPRESULT result 
)

Get a string mobile device property setting.

This is useful for determining more granular features on the device and also an easy way to publish flexible information.

Parameters:
propertyId- unique property Id to get
string- returned value for property
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetDisplaySettings ( [out] CMP_DISPLAY_SETTINGS dispSettings,
[out, retval] CMPRESULT result 
)

Get the current display settings for the mobile device.

Parameters:
dispSettings- retrieved display settings
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetKeyboardState ( [out] CMP_KEYBOARD_STATE kybdState,
[out, retval] CMPRESULT result 
)

Get the current keyboard state.

Parameters:
kybdState- returned keyboard selection and other keyboard settings
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetOrientation ( [out] CMP_ORIENTATION_DATA orientationData,
[out,retval] CMPRESULT result 
)

Get current orientation data.

Get the current orientation data (application and device orientation, orientation flags) from the mobile device. Device and application orientation can be different based on the orientation flags.

Parameters:
orientationData- contains the relevant orientation data
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetPickerState ( [in] CMP_UNIQUE_ID  controlId,
[out] PINT16  pickerState,
[out, retval] CMPRESULT result 
)

Get the picker control state on the mobile device.

Parameters:
controlId- picker control identifier
pickerState- returned picker state
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetPictureFilename ( [in] CMP_UNIQUE_ID  pictureId,
[out] BSTR *  filename,
[out, retval] CMPRESULT result 
)

Get the picture filename from the mobile device.

Get the filename of the picture from the mobile device camera. Once the application has the name, it can directly access the picture data as a file.

Parameters:
pictureId- unique picture identifier
filename- returned filename
result- returned CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetPictureState ( [in] CMP_UNIQUE_ID  pictureId,
[out] INT32 *  size,
[out] CMP_PICTURE_STATE pictState,
[out, retval] CMPRESULT result 
)

Get the current picture state based on unique Id.

Get the picture state from the mobile device camera. This could be used to poll the status of the camera after taking a picture. An alternative is to use the events related to the picture being taken.

Parameters:
pictureId- unique picture identifier
size- returned size of picture
pictState- returned state of the picture (downloading, downloaded)
result- returned CMP-based result
Returns:
HRESULT
STDMETHODIMP ICMPDispatch::GetScrollMode ( [out] CMP_SCROLL_MODE scrollMode,
[out,retval] CMPRESULT result 
)

Get current scroll mode.

Get the current scroll mode from the mobile device. For everything we can set, the intention is being able to retrieve those settings as well.

Parameters:
scrollMode- returned scroll mode
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetSessionState ( [out, retval] CMP_SESSION_STATE sessionState)

Get the current state of the session.

Parameters:
sessionState
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetSupportedOrientations ( [out] CMP_SUPPORTED_ORIENTATIONS supportedOrientations,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetViewport ( [out] INT16 *  flags,
[out] INT16 *  zoomFactor,
[out] CMP_DISPLAY_RECT serverViewport,
[out] CMP_DISPLAY_RECT clientViewport,
[out,retval] CMPRESULT result 
)

Get the current viewport for the mobile device.

Parameters:
flagsindicates which fields are valid
zoomFactorThe amount of zoom used (200 = 2x)
serverViewportThe rectangle coordinates of the server viewport
clientViewportThe rectangle coordinates of the client viewport
resultCMPRESULT
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::GetViewportOrigin ( [in] CMP_DISPLAY_POINT pt,
[out,retval] CMPRESULT result 
)

Get the origin of the Citrix Receiver viewport.

Parameters:
pt- position of the viewport (top, left)
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::HideKeyboard ( [out,retval] CMPRESULT result)

Hide the display keyboard.

Parameters:
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::HidePicker ( [in] CMP_UNIQUE_ID  controlId,
[out, retval] CMPRESULT result 
)

Hide a picker control that is currently being displayed.

Parameters:
controlId- picker control identifier
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::IsChannelOpen ( [out, retval] VARIANT_BOOL *  readyState)

Is virtual channel open.

Check to see if virtual channel is open Determine if the ICA MRVC Virtual Channel is currently open to the other side. If this returns true, the communication between the server and client should be connected and able to exchange ICA packets.

Parameters:
readyState- returns the state of the virtual channel being open
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::IsSessionActive ( [out, retval] VARIANT_BOOL *  sessionActive)

Determine if there is an active session object which is available.

Parameters:
sessionActive
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::NotifyUser ( [in] CMP_UNIQUE_ID  notificationId,
[in] INT16  notificationFlags,
[in] BSTR  notifyText,
[out, retval] CMPRESULT result 
)

Notify the user of an event using a combination of vibration, sound, light, and text.

Parameters:
notificationId- notification identifier
notificationFlags- controls which options are used
notifyText- text to display
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::OpenChannel ( [in] CMP_CHANNEL_FLAGS  channelFlags,
[out, retval] CMPRESULT result 
)

Open the MRVC virtual channel.

Start the link between the two sides. Bind the channel if it has not already been done.

Parameters:
channelFlags- flags to control how the channel is opened
result- result of the operation (optional)
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::OpenSession ( [out, retval] CMPRESULT result)

Open a session between the application and the mobile device.

Parameters:
resultreturn code of CMP call
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::OpenSessionForProcess ( [in] DWORD  processId,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::RegisterCMPProcess ( [in] DWORD  processId,
[out, retval] CMPRESULT result 
)

Register the process as belonging to CMP.

This stops other Citrix programs from adjusting behaviour for mobile device.

Parameters:
processIdProcess Id of the process to register with CMP
resultreturned CMPRESULT
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::RemoveCapturedData ( [in] CMP_UNIQUE_LONG_ID  uniqueId,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::RemovePicture ( [in] CMP_UNIQUE_ID  pictureId,
[out, retval] CMPRESULT result 
)

Remove the picture on the mobile device.

Remove the picture from the mobile device. We no longer need it for download and there is no reason to keep it on the device. This function only works with images that were taken with our API. The pictureId only works with our pictures. The client does not know if it is okay to delete a picture until it is told.

Parameters:
pictureId- unique picture identifier
result- returned CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SendSMS ( [in] BSTR  phoneNumber,
[in] CMP_UNIQUE_ID  msgId,
[in] BSTR  SMSText,
[out, retval] CMPRESULT result 
)

Send a SMS message using the mobile device.

Parameters:
phoneNumber- phone number for destination
msgId- unique message identifier
SMSText- text to send in SMS
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SetButtonTarget ( [in] CMP_BUTTON_ID  button,
[in] CMP_BUTTON_TARGET  target,
[out, retval] CMPRESULT result 
)

Set the target for pressing a button.

Set the destination for button events. The target will either be the server or the client. The host application will be notified of button events if it is selected. Otherwise the client (mobile device) will handle it like normal.

Parameters:
button- selected button (home, search, back, etc.)
target- destination for events (server or client)
result- returned CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SetOrientation ( [in] CMP_ORIENTATION_POSITION  orientation,
[in] INT16  orientationFlags,
[out,retval] CMPRESULT result 
)

Set the application orientation.

Set the application orientation and orientation flags for the mobile device. Device and application orientation can be different based on the orientation flags.

Parameters:
orientation- contains the relevant orientation data
orientationFlags- controls the orientation to either be "follow" or "locked"
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SetScrollMode ( [in] CMP_SCROLL_MODE  scrollMode,
[out,retval] CMPRESULT result 
)

Set the scroll mode from the mobile device.

Parameters:
scrollMode- scroll mode to set CMP_SCROLL_MODE
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SetSupportedOrientations ( [in] CMP_SUPPORTED_ORIENTATIONS  supportedOrientations,
[out, retval] CMPRESULT result 
)

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SetViewport ( [in] INT16  flags,
[in] INT16  zoomFactor,
[in] CMP_DISPLAY_RECT serverViewport,
[out,retval] CMPRESULT result 
)

Set the viewport for the mobile device.

Parameters:
flagsindicates which fields are to be used
zoomFactorThe amount of zoom used (200 = 2x)
serverViewportThe rectangle coordinates of the server viewport
resultCMPRESULT
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::SetViewportOrigin ( [in] CMP_DISPLAY_POINT pt,
[in] INT16  viewportFlags,
[out,retval] CMPRESULT result 
)

Set the origin of the Citrix Receiver viewport.

Parameters:
pt- Location to position the viewport (top, left)
viewportFlags- flags to control how set viewport works
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::ShowKeyboard ( [in] CMP_KEYBOARD_STATE kybdState,
[out,retval] CMPRESULT result 
)

Show the display keyboard with the given properties.

Parameters:
kybdState- keyboard selection and other keyboard settings
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::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 
)

Show the picker control on the mobile device. This version is compatible with automation.

Parameters:
controlId- control identifier
rect- viewport rectangle to use
selectedIndex- which item to have selected by default
pickerText- picker control text
pickerTitle- picker title text
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::StartPhoneCall ( [in] BSTR  phoneNumber,
[in] CMP_UNIQUE_ID  phoneCallId,
[out, retval] CMPRESULT result 
)

Start a phone call.

Initiate a phone call using the mobile device. It is important to worry about how this could be used so it assumed that the dialing process is not fully automated.

Parameters:
phoneNumber- phone number to dial
phoneCallId- unique identifier for phone call
result- result of the operation
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::TakePicture ( [in] CMP_IMAGE_FORMAT  pictureType,
[in] CMP_UNIQUE_ID  pictureId,
[out, retval] CMPRESULT result 
)

Take a picture.

Starts the process of taking a picture on the mobile device camera. The image type is selected to specify which image format should be used. At this time it is either PNG or JPEG. A unique picture Id should be used to track the picture status and be able to retrieve the data

Parameters:
pictureType- picture format type (either JPEG or PNG)
pictureId- unique picture identifier
result- returned CMP-based result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICMPDispatch::UnregisterCMPProcess ( [in] DWORD  processId,
[out, retval] CMPRESULT result 
)

Unregister the process as belonging to CMP.

Parameters:
processId- processId to unregister
result- returned CMPRESULT
Returns:
HRESULT

Reimplemented in CitrixMobile.


The documentation for this struct was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Events Defines