CitrixMobility.ICMPDispatch Interface Reference

Inherited by CitrixMobility.CitrixMobile, and CitrixMobility.CitrixMobileClass.

List of all members.

Public Member Functions
int	GetButtonTarget ([In] CMP_BUTTON_ID Button, out CMP_BUTTON_TARGET target)
	Get the current button target (host of client)
int	SetButtonTarget ([In] CMP_BUTTON_ID Button,[In] CMP_BUTTON_TARGET target)
	Set the target for pressing a button.
int	OpenSession ()
	Open a session between the application and the mobile device.
bool	IsSessionActive ()
	Determine if there is an active session object which is available.
CMP_SESSION_STATE	GetSessionState ()
	Get the current state of the session.
int	CloseSession ()
	Close the session between the application and the mobile device.
int	GetCapabilityBool ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out bool keyValue)
	Get capability boolean value.
int	GetCapabilityInt16 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out short keyValue)
	Get capability integer 16-bit value.
int	GetCapabilityInt32 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out int keyValue)
	Get capability integer 32-bit value.
bool	IsChannelOpen ()
	Is virtual channel open.
int	OpenChannel ([In, ComAliasName("CitrixMobility.CMP_CHANNEL_FLAGS")] int channelFlags)
	Open the MRVC virtual channel.
int	CloseChannel ()
	Close the link between the application and the service.
int	EnableControls ()
	Enable the Receiver Controls for use.
int	DisableControls ()
	Disable the Receiver Controls from being used.
int	GetControlsFlags (out short controlFlags)
	Get the current receiver controls flags.
int	TakePicture ([In] CMP_IMAGE_FORMAT imgType,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int imageID)
	Take a picture.
int	GetPictureState ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID, out int size, out CMP_PICTURE_STATE pictState)
	Get the current picture state based on unique Id.
int	GetPictureFilename ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID,[MarshalAs(UnmanagedType.BStr)] out string Filename)
	Get the picture filename from the mobile device.
int	RemovePicture ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID)
	Remove the picture on the mobile device.
int	GetDevicePropertyBool ([In] CMP_DEV_BOOL_PROP_ID propertyId, out bool deviceBool)
	Get a boolean mobile device property setting.
int	GetDevicePropertyString ([In] CMP_DEV_STRING_PROP_ID propertyId,[MarshalAs(UnmanagedType.BStr)] out string deviceString)
	Get a string mobile device property setting.
int	GetOrientation (out CMP_ORIENTATION_DATA orientationData)
	Get current orientation data.
int	SetOrientation ([In] CMP_ORIENTATION_POSITION orientation,[In] short OrientationFlags)
	Set the application orientation.
int	GetScrollMode (out CMP_SCROLL_MODE ScrollMode)
	Get current scroll mode.
int	SetScrollMode ([In] CMP_SCROLL_MODE ScrollMode)
	Set the scroll mode from the mobile device.
int	SetViewportOrigin ([In] ref CMP_DISPLAY_POINT pt,[In] short viewportFlags)
	Set the origin of the Citrix Receiver viewport.
int	GetViewportOrigin ([In] ref CMP_DISPLAY_POINT pt)
	Get the origin of the Citrix Receiver viewport.
int	GetDisplaySettings (out CMP_DISPLAY_SETTINGS dispSettings)
	Get the current display settings for the mobile device.
int	NotifyUser ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int NotificationId,[In] short notificationFlags,[In, MarshalAs(UnmanagedType.BStr)] string notificationText)
	Notify the user of an event using a combination of vibration, sound, light, and text.
int	StartPhoneCall ([In, MarshalAs(UnmanagedType.BStr)] string phoneNumber,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int phoneCallId)
	Start a phone call.
int	SendSMS ([In, MarshalAs(UnmanagedType.BStr)] string phoneNumber,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int MsgId,[In, MarshalAs(UnmanagedType.BStr)] string SMSText)
int	HideKeyboard ()
	Hide the display keyboard.
int	ShowKeyboard ([In] ref CMP_KEYBOARD_STATE kybdState)
	Show the display keyboard with the given properties.
int	GetKeyboardState (out CMP_KEYBOARD_STATE kybdState)
	Get the current keyboard state.
int	HidePicker ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId)
	Hide a picker control that is currently being displayed.
int	GetPickerState ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId, out short pickerState)
	Get the picker control state on the mobile device.
int	ShowPicker ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId,[In] ref CMP_DISPLAY_RECT rect,[In] int selectedIndex,[In, MarshalAs(UnmanagedType.SafeArray, SafeArraySubType=VarEnum.VT_BSTR)] ref string[] pickerText,[In, MarshalAs(UnmanagedType.BStr)] string pickerTitle)
	Show the picker control on the mobile device. This version is compatible with automation.
int	SetViewport ([In] short flags,[In] short zoomFactor,[In] ref CMP_DISPLAY_RECT serverViewport)
	Set the viewport for the mobile device.
int	GetViewport (out short flags, out short zoomFactor, out CMP_DISPLAY_RECT serverViewport, out CMP_DISPLAY_RECT clientViewport)
	Get the current viewport for the mobile device.
CMP_CHANNEL_STATE	GetChannelState ()
	Get the current state of the channel.
int	RegisterCMPProcess ([In] uint processId)
	Register the process as belonging to CMP.
int	UnregisterCMPProcess ([In] uint processId)
	Unregister the process as belonging to CMP.
int	DetectCMPProcess ([In] uint processId, out bool flag)
	Detect if a process is using CMP.
int	OpenSessionForProcess ([In] uint processId)
int	CapturePicture ([In] ref CMP_CAPTURE_PICTURE_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
int	CaptureVideo ([In] ref CMP_CAPTURE_VIDEO_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
int	CaptureAudio ([In] ref CMP_CAPTURE_AUDIO_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
int	RemoveCapturedData ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId)
int	SetSupportedOrientations ([In] CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
int	GetSupportedOrientations (out CMP_SUPPORTED_ORIENTATIONS supportedOrientations)

---

Member Function Documentation

int CitrixMobility.ICMPDispatch.CaptureAudio	(	[In] ref CMP_CAPTURE_AUDIO_OPTIONS	options,
		[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long	uniqueId
	)

Implemented in CitrixMobility.CitrixMobileClass.

int CitrixMobility.ICMPDispatch.CapturePicture	(	[In] ref CMP_CAPTURE_PICTURE_OPTIONS	options,
		[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long	uniqueId
	)

Implemented in CitrixMobility.CitrixMobileClass.

int CitrixMobility.ICMPDispatch.CaptureVideo	(	[In] ref CMP_CAPTURE_VIDEO_OPTIONS	options,
		[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long	uniqueId
	)

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::CloseChannel

(

)

Close the link between the application and the service.

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::CloseSession

(

)

Close the session between the application and the mobile device.

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::DetectCMPProcess	(	[In] uint	processId,
		out bool	detectFlag
	)

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:

processId	process Id of the process to be checked
detectFlag	indicates if it is using CMP (TRUE) or it is a legacy application (FALSE)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::DisableControls

(

)

Disable the Receiver Controls from being used.

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::EnableControls

(

)

Enable the Receiver Controls for use.

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetButtonTarget	(	[In] CMP_BUTTON_ID	button,
		out CMP_BUTTON_TARGET	target
	)

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.

If this function is used in .NET, the target must be initialized to a valid CMP_BUTTON_TARGET value. Even though it is usually okay to let the function initialize the "out" variable, it is not always good for a COM Interop function. If the target value is not initialized, it could report CMP_ERROR_NULL_PARAMETER.

Parameters:

button	- selected button (home, search, back, etc.)
target	- destination for events (server or client)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetCapabilityBool	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out bool	keyValue
	)

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)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetCapabilityInt16	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out short	keyValue
	)

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)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetCapabilityInt32	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out int	keyValue
	)

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)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

CMP_CHANNEL_STATE ICMPDispatch::GetChannelState

(

)

Get the current state of the channel.

Returns:

CMP_CHANNEL_STATE returned channel state CMP_CHANNEL_STATE

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetControlsFlags

(

out short

controlFlags

)

Get the current receiver controls flags.

Parameters:

controlFlags

- returned flags for controls

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetDevicePropertyBool	(	[In] CMP_DEV_BOOL_PROP_ID	propertyId,
		out bool	value
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetDevicePropertyString	(	[In] CMP_DEV_STRING_PROP_ID	propertyId,
		[MarshalAs(UnmanagedType.BStr)] out string	value
	)

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
value	- returned value for property

Returns:

HRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetDisplaySettings

(

out CMP_DISPLAY_SETTINGS

dispSettings

)

Get the current display settings for the mobile device.

Parameters:

dispSettings

- retrieved display settings

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetKeyboardState

(

out CMP_KEYBOARD_STATE

kybdState

)

Get the current keyboard state.

Parameters:

kybdState

- returned keyboard selection and other keyboard settings

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetOrientation

(

out CMP_ORIENTATION_DATA

orientationData

)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetPickerState	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	controlId,
		out short	pickerState
	)

Get the picker control state on the mobile device.

Parameters:

controlId	- picker control identifier
pickerState	- returned picker state

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetPictureFilename	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	pictureId,
		[MarshalAs(UnmanagedType.BStr)] out string	filename
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetPictureState	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	pictureId,
		out int	size,
		out CMP_PICTURE_STATE	pictState
	)

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)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetScrollMode

(

out CMP_SCROLL_MODE

scrollMode

)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

CMP_SESSION_STATE ICMPDispatch::GetSessionState

(

)

Get the current state of the session.

Returns:

CMP_SESSION_STATE

Implemented in CitrixMobility.CitrixMobileClass.

int CitrixMobility.ICMPDispatch.GetSupportedOrientations

(

out CMP_SUPPORTED_ORIENTATIONS

supportedOrientations

)

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetViewport	(	out short	flags,
		out short	zoomFactor,
		out CMP_DISPLAY_RECT	serverViewport,
		out CMP_DISPLAY_RECT	clientViewport
	)

Get the current viewport for the mobile device.

Parameters:

flags	indicates which fields are valid
zoomFactor	The amount of zoom used (200 = 2x)
serverViewport	The rectangle coordinates of the server viewport
clientViewport	The rectangle coordinates of the client viewport

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::GetViewportOrigin

(

[In] ref CMP_DISPLAY_POINT

pt

)

Get the origin of the Citrix Receiver viewport.

Parameters:

pt	- position of the viewport (top, left)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::HideKeyboard

(

)

Hide the display keyboard.

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::HidePicker

(

[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int

controlId

)

Hide a picker control that is currently being displayed.

Parameters:

controlId

- picker control identifier

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

bool ICMPDispatch::IsChannelOpen

(

)

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.

Returns:

bool returns the state of the virtual channel being open

Implemented in CitrixMobility.CitrixMobileClass.

bool ICMPDispatch::IsSessionActive

(

)

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

Returns:

bool

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::NotifyUser	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	notificationId,
		[In] short	notificationFlags,
		[In, MarshalAs(UnmanagedType.BStr)] string	notifyText
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::OpenChannel

(

[In, ComAliasName("CitrixMobility.CMP_CHANNEL_FLAGS")] int

channelFlags

)

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 (currently just 0 is valid)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::OpenSession

(

)

Open a session between the application and the mobile device.

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int CitrixMobility.ICMPDispatch.OpenSessionForProcess

(

[In] uint

processId

)

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::RegisterCMPProcess

(

[In] uint

processId

)

Register the process as belonging to CMP.

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

Parameters:

processId

Process Id of the process to register with CMP

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int CitrixMobility.ICMPDispatch.RemoveCapturedData

(

[In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long

uniqueId

)

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::RemovePicture

(

[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int

pictureId

)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::SendSMS	(	[In, MarshalAs(UnmanagedType.BStr)] string	phoneNumber,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	msgId,
		[In, MarshalAs(UnmanagedType.BStr)] string	SMSText
	)

Send a SMS message using the mobile device

Parameters:

phoneNumber	- phone number for destination
msgId	- unique message identifier
SMSText	- text to send in SMS

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::SetButtonTarget	(	[In] CMP_BUTTON_ID	button,
		[In] CMP_BUTTON_TARGET	target
	)

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)

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::SetOrientation	(	[In] CMP_ORIENTATION_POSITION	orientation,
		[In] short	orientationFlags
	)

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"

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::SetScrollMode

(

[In] CMP_SCROLL_MODE

scrollMode

)

Set the scroll mode from the mobile device.

Parameters:

scrollMode

- scroll mode to set CMP_SCROLL_MODE

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int CitrixMobility.ICMPDispatch.SetSupportedOrientations

(

[In] CMP_SUPPORTED_ORIENTATIONS

supportedOrientations

)

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::SetViewport	(	[In] short	flags,
		[In] short	zoomFactor,
		[In] ref CMP_DISPLAY_RECT	serverViewport
	)

Set the viewport for the mobile device.

Parameters:

flags	indicates which fields are to be used
zoomFactor	The amount of zoom used (200 = 2x)
serverViewport	The rectangle coordinates of the server viewport

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::SetViewportOrigin	(	[In] ref CMP_DISPLAY_POINT	pt,
		[In] short	viewportFlags
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::ShowKeyboard

(

[In] ref CMP_KEYBOARD_STATE

kybdState

)

Show the display keyboard with the given properties.

Parameters:

kybdState

- keyboard selection and other keyboard settings

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::ShowPicker	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	controlId,
		[In] ref CMP_DISPLAY_RECT	rect,
		[In] int	selectedIndex,
		[In, MarshalAs(UnmanagedType.SafeArray, SafeArraySubType=VarEnum.VT_BSTR)] ref string[]	pickerText,
		[In, MarshalAs(UnmanagedType.BStr)] string	pickerTitle
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::StartPhoneCall	(	[In, MarshalAs(UnmanagedType.BStr)] string	phoneNumber,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	phoneCallId
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::TakePicture	(	[In] CMP_IMAGE_FORMAT	pictureType,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	pictureId
	)

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

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

int ICMPDispatch::UnregisterCMPProcess

(

[In] uint

processId

)

Unregister the process as belonging to CMP.

Parameters:

processId

- processId to unregister

Returns:

CMPRESULT

Implemented in CitrixMobility.CitrixMobileClass.

---

The documentation for this interface was generated from the following files:

• InteropCMPReflector.cs
• cmpcom_en.txt