Inherits CitrixMobility.ICMPDispatch, CitrixMobility.CitrixMobile, CitrixMobility.ICMPEvents_Event, CitrixMobility.IButton, CitrixMobility.ICamera, CitrixMobility.ICapabilities, CitrixMobility.IChannel, CitrixMobility.ICMPDevice, CitrixMobility.IControl, CitrixMobility.IDisplay, CitrixMobility.IEventFilter, CitrixMobility.IEventSource, CitrixMobility.IKeyboard, CitrixMobility.IMessage, CitrixMobility.INotification, CitrixMobility.IPhone, CitrixMobility.IPicker, CitrixMobility.ISession, CitrixMobility.IVirtualDevice, CitrixMobility.ICMPCapture, and CitrixMobility.IOrientation.

Public Member Functions
virtual int	CaptureAudio ([In] ref CMP_CAPTURE_AUDIO_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
virtual int	CapturePicture ([In] ref CMP_CAPTURE_PICTURE_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
virtual int	CaptureVideo ([In] ref CMP_CAPTURE_VIDEO_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
virtual int	CloseChannel ()
virtual int	CloseSession ()
	Close the session between the application and the mobile device.
virtual int	DetectCMPProcess ([In] uint processId, out bool flag)
	Detect if a process is using CMP.
virtual int	DisableControls ()
	Disable the Receiver Controls from being used.
virtual int	EnableControls ()
	Enable the Receiver Controls for use.
virtual int	FilterEvent ([In] CMP_EVENT_ID EventId,[In] short FilterFlags)
virtual int	GetButtonTarget ([In] CMP_BUTTON_ID Button, out CMP_BUTTON_TARGET target)
virtual int	GetCapabilityBool ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out bool keyValue)
virtual int	GetCapabilityInt16 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out short keyValue)
virtual int	GetCapabilityInt32 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out int keyValue)
virtual int	GetCapabilityUInt16 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out ushort keyValue)
virtual int	GetCapabilityUInt32 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out uint keyValue)
virtual CMP_CHANNEL_STATE	GetChannelState ()
virtual int	GetControlsFlags (out short controlFlags)
	Get the current receiver controls flags.
virtual int	GetDevicePropertyBool ([In] CMP_DEV_BOOL_PROP_ID propertyId, out bool deviceBool)
virtual int	GetDevicePropertyString ([In] CMP_DEV_STRING_PROP_ID propertyId,[MarshalAs(UnmanagedType.BStr)] out string deviceString)
	Get a string mobile device property setting.
virtual int	GetDisplaySettings (out CMP_DISPLAY_SETTINGS dispSettings)
	Get the current display settings for the mobile device.
virtual int	GetErrorText ([In] CMP_ERROR_ID ErrorId,[MarshalAs(UnmanagedType.BStr)] out string ErrorText)
virtual int	GetKeyboardState (out CMP_KEYBOARD_STATE kybdState)
	Get the current keyboard state.
virtual int	GetOrientation (out CMP_ORIENTATION_DATA orientationData)
	Get current orientation data.
virtual int	GetPickerState ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId, out short pickerState)
	Get the picker control state on the mobile device.
virtual int	GetPictureFilename ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID,[MarshalAs(UnmanagedType.BStr)] out string Filename)
virtual int	GetPictureState ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID, out int size, out CMP_PICTURE_STATE pictState)
virtual int	GetScrollMode (out CMP_SCROLL_MODE ScrollMode)
	Get current scroll mode.
virtual int	GetSessionOptionBool ([In] CMP_SESSION_OPTION option, out bool value)
virtual CMP_SESSION_STATE	GetSessionState ()
	Get the current state of the session.
virtual int	GetSupportedOrientations (out CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
virtual 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.
virtual int	GetViewportOrigin ([In] ref CMP_DISPLAY_POINT pt)
	Get the origin of the Citrix Receiver viewport.
virtual int	HideKeyboard ()
	Hide the display keyboard.
virtual int	HidePicker ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId)
	Hide a picker control that is currently being displayed.
virtual int	IButton_GetButtonTarget ([In] CMP_BUTTON_ID Button, out CMP_BUTTON_TARGET target)
virtual int	IButton_SetButtonTarget ([In] CMP_BUTTON_ID Button,[In] CMP_BUTTON_TARGET target)
virtual int	ICamera_GetPictureFilename ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID,[MarshalAs(UnmanagedType.BStr)] out string Filename)
virtual int	ICamera_GetPictureState ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID, out int size, out CMP_PICTURE_STATE pictState)
virtual int	ICamera_RemovePicture ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID)
virtual int	ICamera_TakePicture ([In] CMP_IMAGE_FORMAT pictureType,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID)
virtual int	ICapabilities_GetCapabilityBool ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out bool keyValue)
virtual int	ICapabilities_GetCapabilityInt16 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out short keyValue)
virtual int	ICapabilities_GetCapabilityInt32 ([In] CMP_CAP_ID capId,[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short keyId, out int keyValue)
virtual int	IChannel_CloseChannel ()
virtual CMP_CHANNEL_STATE	IChannel_GetChannelState ()
virtual bool	IChannel_IsChannelOpen ()
virtual int	IChannel_OpenChannel ([In, ComAliasName("CitrixMobility.CMP_CHANNEL_FLAGS")] int channelFlags)
virtual int	ICMPCapture_CaptureAudio ([In] ref CMP_CAPTURE_AUDIO_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
virtual int	ICMPCapture_CapturePicture ([In] ref CMP_CAPTURE_PICTURE_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
virtual int	ICMPCapture_CaptureVideo ([In] ref CMP_CAPTURE_VIDEO_OPTIONS options,[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long uniqueId)
virtual int	ICMPCapture_RemoveCapturedData ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId)
virtual int	ICMPDevice_GetDevicePropertyBool ([In] CMP_DEV_BOOL_PROP_ID propertyId, out bool value)
virtual int	ICMPDevice_GetDevicePropertyString ([In] CMP_DEV_STRING_PROP_ID propertyId,[MarshalAs(UnmanagedType.BStr)] out string @string)
virtual int	IControl_DisableControls ()
virtual int	IControl_EnableControls ()
virtual int	IControl_GetControlsFlags (out short controlFlags)
virtual int	IDisplay_GetDisplaySettings (out CMP_DISPLAY_SETTINGS dispSettings)
virtual int	IDisplay_GetOrientation (out CMP_ORIENTATION_DATA orientationData)
virtual int	IDisplay_GetScrollMode (out CMP_SCROLL_MODE ScrollMode)
virtual int	IDisplay_GetViewport (out short flags, out short zoomFactor, out CMP_DISPLAY_RECT serverViewport, out CMP_DISPLAY_RECT clientViewport)
virtual int	IDisplay_GetViewportOrigin ([In] ref CMP_DISPLAY_POINT pt)
virtual int	IDisplay_SetOrientation ([In] CMP_ORIENTATION_POSITION orientation,[In] short OrientationFlags)
virtual int	IDisplay_SetScrollMode ([In] CMP_SCROLL_MODE ScrollMode)
virtual int	IDisplay_SetViewport ([In] short flags,[In] short zoomFactor,[In] ref CMP_DISPLAY_RECT serverViewport)
virtual int	IDisplay_SetViewportOrigin ([In] ref CMP_DISPLAY_POINT pt,[In] short viewportFlags)
virtual int	IKeyboard_GetKeyboardState (out CMP_KEYBOARD_STATE kybdState)
virtual int	IKeyboard_HideKeyboard ()
virtual int	IKeyboard_ShowKeyboard ([In] ref CMP_KEYBOARD_STATE kybdState)
virtual int	IMessage_SendSMS ([In, MarshalAs(UnmanagedType.BStr)] string phoneNumber,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int MsgId,[In, MarshalAs(UnmanagedType.BStr)] string SMSText)
virtual int	INotification_NotifyUser ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int NotificationId,[In] short notificationFlags,[In, MarshalAs(UnmanagedType.BStr)] string notifyText)
virtual int	IOrientation_GetOrientation (out CMP_ORIENTATION_DATA orientationData)
virtual int	IOrientation_GetSupportedOrientations (out CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
virtual int	IOrientation_SetOrientation ([In] CMP_ORIENTATION_POSITION orientation,[In] short OrientationFlags)
virtual int	IOrientation_SetSupportedOrientations ([In] CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
virtual int	IPhone_StartPhoneCall ([In, MarshalAs(UnmanagedType.BStr)] string phoneNumber,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int phoneCallId)
virtual int	IPicker_GetPickerState ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId, out short pickerState)
virtual int	IPicker_HidePicker ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId)
virtual bool	IsChannelOpen ()
virtual int	ISession_CloseSession ()
virtual int	ISession_DetectCMPProcess ([In] uint processId, out bool detectFlag)
virtual CMP_SESSION_STATE	ISession_GetSessionState ()
virtual bool	ISession_IsSessionActive ()
virtual int	ISession_OpenSession ()
virtual int	ISession_RegisterCMPProcess ([In] uint processId)
virtual int	ISession_UnregisterCMPProcess ([In] uint processId)
virtual bool	IsSessionActive ()
	Determine if there is an active session object which is available.
virtual int	IVirtualDevice_OpenSessionForProcess ([In] uint processId)
virtual 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.
virtual int	OpenChannel ([In, ComAliasName("CitrixMobility.CMP_CHANNEL_FLAGS")] int channelFlags)
virtual int	OpenSession ()
	Open a session between the application and the mobile device.
virtual int	OpenSessionForProcess ([In] uint processId)
virtual int	RegisterCMPProcess ([In] uint processId)
	Register the process as belonging to CMP.
virtual int	RemoveCapturedData ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId)
virtual int	RemovePicture ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID)
virtual int	SendSMS ([In, MarshalAs(UnmanagedType.BStr)] string phoneNumber,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int MsgId,[In, MarshalAs(UnmanagedType.BStr)] string SMSText)
virtual int	SetButtonTarget ([In] CMP_BUTTON_ID Button,[In] CMP_BUTTON_TARGET target)
virtual int	SetOrientation ([In] CMP_ORIENTATION_POSITION orientation,[In] short OrientationFlags)
	Set the application orientation.
virtual int	SetScrollMode ([In] CMP_SCROLL_MODE ScrollMode)
	Set the scroll mode from the mobile device.
virtual int	SetSessionOptionBool ([In] CMP_SESSION_OPTION option,[In] bool value)
virtual int	SetSupportedOrientations ([In] CMP_SUPPORTED_ORIENTATIONS supportedOrientations)
virtual int	SetViewport ([In] short flags,[In] short zoomFactor,[In] ref CMP_DISPLAY_RECT serverViewport)
	Set the viewport for the mobile device.
virtual int	SetViewportOrigin ([In] ref CMP_DISPLAY_POINT pt,[In] short viewportFlags)
	Set the origin of the Citrix Receiver viewport.
virtual int	ShowKeyboard ([In] ref CMP_KEYBOARD_STATE kybdState)
	Show the display keyboard with the given properties.
virtual 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.
virtual int	ShowPicker ([In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId,[In] ref CMP_DISPLAY_RECT rect,[In] int selectedIndex,[In, MarshalAs(UnmanagedType.BStr)] string bstrList,[In, MarshalAs(UnmanagedType.BStr)] string bstrTitle)
virtual int	StartPhoneCall ([In, MarshalAs(UnmanagedType.BStr)] string phoneNumber,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int phoneCallId)
	Start a phone call.
virtual int	TakePicture ([In] CMP_IMAGE_FORMAT imgType,[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int imageID)
virtual int	UnregisterCMPProcess ([In] uint processId)
	Unregister the process as belonging to CMP.
Events
ICMPEvents_AppBackgroundEventHandler	AppBackground
ICMPEvents_AppForegroundEventHandler	AppForeground
ICMPEvents_AudioCapturedEventHandler	AudioCaptured
ICMPEvents_ButtonPressedEventHandler	ButtonPressed
ICMPEvents_ButtonTargetChangedEventHandler	ButtonTargetChanged
ICMPEvents_CameraPictureRemovedEventHandler	CameraPictureRemoved
ICMPEvents_CaptureMediaRemovedEventHandler	CaptureMediaRemoved
ICMPEvents_ChannelStateChangedEventHandler	ChannelStateChanged
ICMPEvents_ControlStateChangedEventHandler	ControlStateChanged
ICMPEvents_DisplaySettingsChangedEventHandler	DisplaySettingsChanged
ICMPEvents_EventFilterChangedEventHandler	EventFilterChanged
ICMPEvents_ForegroundAppChangedEventHandler	ForegroundAppChanged
ICMPEvents_KeyboardStateChangedEventHandler	KeyboardStateChanged
ICMPEvents_OrientationChangedEventHandler	OrientationChanged
ICMPEvents_PhoneCallStartedEventHandler	PhoneCallStarted
ICMPEvents_PickerControlStateChangedEventHandler	PickerControlStateChanged
ICMPEvents_PictureCapturedEventHandler	PictureCaptured
ICMPEvents_PictureTakenEventHandler	PictureTaken
ICMPEvents_ScrollModeChangedEventHandler	ScrollModeChanged
ICMPEvents_SessionStateChangedEventHandler	SessionStateChanged
ICMPEvents_SMSStartedEventHandler	SMSStarted
ICMPEvents_SupportedOrientationsChangedEventHandler	SupportedOrientationsChanged
ICMPEvents_UserNotifiedEventHandler	UserNotified
ICMPEvents_VideoCapturedEventHandler	VideoCaptured
ICMPEvents_ViewportChangedEventHandler	ViewportChanged
ICMPEvents_ViewportOriginChangedEventHandler	ViewportOriginChanged

Member Function Documentation

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

Implements CitrixMobility.ICMPCapture.

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

Implements CitrixMobility.ICMPCapture.

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

Implements CitrixMobility.ICMPCapture.

virtual int CitrixMobility.CitrixMobileClass.CloseChannel ( ) [virtual]

Implements CitrixMobility.IChannel.

virtual int CitrixMobility.CitrixMobileClass.CloseSession ( ) [virtual]

Close the session between the application and the mobile device.

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.DetectCMPProcess	(	[In] uint	processId,
		out bool	detectFlag
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.DisableControls ( ) [virtual]

Disable the Receiver Controls from being used.

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.EnableControls ( ) [virtual]

Enable the Receiver Controls for use.

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.FilterEvent	(	[In] CMP_EVENT_ID	EventId,
		[In] short	FilterFlags
	)		`[virtual]`

Implements CitrixMobility.IEventFilter.

virtual int CitrixMobility.CitrixMobileClass.GetButtonTarget	(	[In] CMP_BUTTON_ID	Button,
		out CMP_BUTTON_TARGET	target
	)		`[virtual]`

Implements CitrixMobility.IButton.

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

Implements CitrixMobility.ICapabilities.

virtual int CitrixMobility.CitrixMobileClass.GetCapabilityInt16	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out short	keyValue
	)		`[virtual]`

Implements CitrixMobility.ICapabilities.

virtual int CitrixMobility.CitrixMobileClass.GetCapabilityInt32	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out int	keyValue
	)		`[virtual]`

Implements CitrixMobility.ICapabilities.

virtual int CitrixMobility.CitrixMobileClass.GetCapabilityUInt16	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out ushort	keyValue
	)		`[virtual]`

Implements CitrixMobility.ICapabilities.

virtual int CitrixMobility.CitrixMobileClass.GetCapabilityUInt32	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out uint	keyValue
	)		`[virtual]`

Implements CitrixMobility.ICapabilities.

virtual CMP_CHANNEL_STATE CitrixMobility.CitrixMobileClass.GetChannelState ( ) [virtual]

Implements CitrixMobility.IChannel.

virtual int CitrixMobility.CitrixMobileClass.GetControlsFlags ( out short controlFlags ) [virtual]

Get the current receiver controls flags.

Parameters:

controlFlags - returned flags for controls

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetDevicePropertyBool	(	[In] CMP_DEV_BOOL_PROP_ID	propertyId,
		out bool	deviceBool
	)		`[virtual]`

Implements CitrixMobility.ICMPDevice.

virtual int CitrixMobility.CitrixMobileClass.GetDevicePropertyString	(	[In] CMP_DEV_STRING_PROP_ID	propertyId,
		[MarshalAs(UnmanagedType.BStr)] out string	value
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetDisplaySettings ( out CMP_DISPLAY_SETTINGS dispSettings ) [virtual]

Get the current display settings for the mobile device.

Parameters:

dispSettings - retrieved display settings

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetErrorText	(	[In] CMP_ERROR_ID	ErrorId,
		[MarshalAs(UnmanagedType.BStr)] out string	ErrorText
	)		`[virtual]`

Implements CitrixMobility.ISession.

virtual int CitrixMobility.CitrixMobileClass.GetKeyboardState ( out CMP_KEYBOARD_STATE kybdState ) [virtual]

Get the current keyboard state.

Parameters:

kybdState - returned keyboard selection and other keyboard settings

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetOrientation ( out CMP_ORIENTATION_DATA orientationData ) [virtual]

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetPickerState	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	controlId,
		out short	pickerState
	)		`[virtual]`

Get the picker control state on the mobile device.

Parameters:

controlId	- picker control identifier
pickerState	- returned picker state

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetPictureFilename	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID,
		[MarshalAs(UnmanagedType.BStr)] out string	Filename
	)		`[virtual]`

Implements CitrixMobility.ICamera.

virtual int CitrixMobility.CitrixMobileClass.GetPictureState	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID,
		out int	size,
		out CMP_PICTURE_STATE	pictState
	)		`[virtual]`

Implements CitrixMobility.ICamera.

virtual int CitrixMobility.CitrixMobileClass.GetScrollMode ( out CMP_SCROLL_MODE scrollMode ) [virtual]

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetSessionOptionBool	(	[In] CMP_SESSION_OPTION	option,
		out bool	value
	)		`[virtual]`

Implements CitrixMobility.ISession.

virtual CMP_SESSION_STATE CitrixMobility.CitrixMobileClass.GetSessionState ( ) [virtual]

Get the current state of the session.

Returns:: CMP_SESSION_STATE

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetSupportedOrientations ( out CMP_SUPPORTED_ORIENTATIONS supportedOrientations ) [virtual]

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetViewport	(	out short	flags,
		out short	zoomFactor,
		out CMP_DISPLAY_RECT	serverViewport,
		out CMP_DISPLAY_RECT	clientViewport
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.GetViewportOrigin ( [In] ref CMP_DISPLAY_POINT pt ) [virtual]

Get the origin of the Citrix Receiver viewport.

Parameters:

pt	- position of the viewport (top, left)

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.HideKeyboard ( ) [virtual]

Hide the display keyboard.

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.HidePicker ( [In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int controlId ) [virtual]

Hide a picker control that is currently being displayed.

Parameters:

controlId - picker control identifier

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.IButton_GetButtonTarget	(	[In] CMP_BUTTON_ID	Button,
		out CMP_BUTTON_TARGET	target
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IButton_SetButtonTarget	(	[In] CMP_BUTTON_ID	Button,
		[In] CMP_BUTTON_TARGET	target
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICamera_GetPictureFilename	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID,
		[MarshalAs(UnmanagedType.BStr)] out string	Filename
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICamera_GetPictureState	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID,
		out int	size,
		out CMP_PICTURE_STATE	pictState
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICamera_RemovePicture ( [In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ICamera_TakePicture	(	[In] CMP_IMAGE_FORMAT	pictureType,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	PictureID
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICapabilities_GetCapabilityBool	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out bool	keyValue
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICapabilities_GetCapabilityInt16	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out short	keyValue
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICapabilities_GetCapabilityInt32	(	[In] CMP_CAP_ID	capId,
		[In, ComAliasName("CitrixMobility.CMP_KEY_ID")] short	keyId,
		out int	keyValue
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IChannel_CloseChannel ( ) [virtual]

virtual CMP_CHANNEL_STATE CitrixMobility.CitrixMobileClass.IChannel_GetChannelState ( ) [virtual]

virtual bool CitrixMobility.CitrixMobileClass.IChannel_IsChannelOpen ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IChannel_OpenChannel ( [In, ComAliasName("CitrixMobility.CMP_CHANNEL_FLAGS")] int channelFlags ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ICMPCapture_CaptureAudio	(	[In] ref CMP_CAPTURE_AUDIO_OPTIONS	options,
		[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long	uniqueId
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICMPCapture_CapturePicture	(	[In] ref CMP_CAPTURE_PICTURE_OPTIONS	options,
		[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long	uniqueId
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICMPCapture_CaptureVideo	(	[In] ref CMP_CAPTURE_VIDEO_OPTIONS	options,
		[ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] out long	uniqueId
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICMPCapture_RemoveCapturedData ( [In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ICMPDevice_GetDevicePropertyBool	(	[In] CMP_DEV_BOOL_PROP_ID	propertyId,
		out bool	value
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.ICMPDevice_GetDevicePropertyString	(	[In] CMP_DEV_STRING_PROP_ID	propertyId,
		[MarshalAs(UnmanagedType.BStr)] out string @	string
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IControl_DisableControls ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IControl_EnableControls ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IControl_GetControlsFlags ( out short controlFlags ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IDisplay_GetDisplaySettings ( out CMP_DISPLAY_SETTINGS dispSettings ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IDisplay_GetOrientation ( out CMP_ORIENTATION_DATA orientationData ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IDisplay_GetScrollMode ( out CMP_SCROLL_MODE ScrollMode ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IDisplay_GetViewport	(	out short	flags,
		out short	zoomFactor,
		out CMP_DISPLAY_RECT	serverViewport,
		out CMP_DISPLAY_RECT	clientViewport
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IDisplay_GetViewportOrigin ( [In] ref CMP_DISPLAY_POINT pt ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IDisplay_SetOrientation	(	[In] CMP_ORIENTATION_POSITION	orientation,
		[In] short	OrientationFlags
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IDisplay_SetScrollMode ( [In] CMP_SCROLL_MODE ScrollMode ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IDisplay_SetViewport	(	[In] short	flags,
		[In] short	zoomFactor,
		[In] ref CMP_DISPLAY_RECT	serverViewport
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IDisplay_SetViewportOrigin	(	[In] ref CMP_DISPLAY_POINT	pt,
		[In] short	viewportFlags
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IKeyboard_GetKeyboardState ( out CMP_KEYBOARD_STATE kybdState ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IKeyboard_HideKeyboard ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IKeyboard_ShowKeyboard ( [In] ref CMP_KEYBOARD_STATE kybdState ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IMessage_SendSMS	(	[In, MarshalAs(UnmanagedType.BStr)] string	phoneNumber,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	MsgId,
		[In, MarshalAs(UnmanagedType.BStr)] string	SMSText
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.INotification_NotifyUser	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	NotificationId,
		[In] short	notificationFlags,
		[In, MarshalAs(UnmanagedType.BStr)] string	notifyText
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IOrientation_GetOrientation ( out CMP_ORIENTATION_DATA orientationData ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IOrientation_GetSupportedOrientations ( out CMP_SUPPORTED_ORIENTATIONS supportedOrientations ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IOrientation_SetOrientation	(	[In] CMP_ORIENTATION_POSITION	orientation,
		[In] short	OrientationFlags
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IOrientation_SetSupportedOrientations ( [In] CMP_SUPPORTED_ORIENTATIONS supportedOrientations ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.IPhone_StartPhoneCall	(	[In, MarshalAs(UnmanagedType.BStr)] string	phoneNumber,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	phoneCallId
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IPicker_GetPickerState	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	ControlId,
		out short	pickerState
	)		`[virtual]`

virtual int CitrixMobility.CitrixMobileClass.IPicker_HidePicker ( [In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int ControlId ) [virtual]

virtual bool CitrixMobility.CitrixMobileClass.IsChannelOpen ( ) [virtual]

Implements CitrixMobility.IChannel.

virtual int CitrixMobility.CitrixMobileClass.ISession_CloseSession ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ISession_DetectCMPProcess	(	[In] uint	processId,
		out bool	detectFlag
	)		`[virtual]`

virtual CMP_SESSION_STATE CitrixMobility.CitrixMobileClass.ISession_GetSessionState ( ) [virtual]

virtual bool CitrixMobility.CitrixMobileClass.ISession_IsSessionActive ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ISession_OpenSession ( ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ISession_RegisterCMPProcess ( [In] uint processId ) [virtual]

virtual int CitrixMobility.CitrixMobileClass.ISession_UnregisterCMPProcess ( [In] uint processId ) [virtual]

virtual bool CitrixMobility.CitrixMobileClass.IsSessionActive ( ) [virtual]

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

Returns:: bool

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.IVirtualDevice_OpenSessionForProcess ( [In] uint processId ) [virtual]

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

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.OpenChannel ( [In, ComAliasName("CitrixMobility.CMP_CHANNEL_FLAGS")] int channelFlags ) [virtual]

Implements CitrixMobility.IChannel.

virtual int CitrixMobility.CitrixMobileClass.OpenSession ( ) [virtual]

Open a session between the application and the mobile device.

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.OpenSessionForProcess ( [In] uint processId ) [virtual]

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.RegisterCMPProcess ( [In] uint processId ) [virtual]

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.RemoveCapturedData ( [In, ComAliasName("CitrixMobility.CMP_UNIQUE_LONG_ID")] long uniqueId ) [virtual]

Implements CitrixMobility.ICMPCapture.

virtual int CitrixMobility.CitrixMobileClass.RemovePicture ( [In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int PictureID ) [virtual]

Implements CitrixMobility.ICamera.

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

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.SetButtonTarget	(	[In] CMP_BUTTON_ID	Button,
		[In] CMP_BUTTON_TARGET	target
	)		`[virtual]`

Implements CitrixMobility.IButton.

virtual int CitrixMobility.CitrixMobileClass.SetOrientation	(	[In] CMP_ORIENTATION_POSITION	orientation,
		[In] short	orientationFlags
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.SetScrollMode ( [In] CMP_SCROLL_MODE scrollMode ) [virtual]

Set the scroll mode from the mobile device.

Parameters:

scrollMode - scroll mode to set CMP_SCROLL_MODE

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.SetSessionOptionBool	(	[In] CMP_SESSION_OPTION	option,
		[In] bool	value
	)		`[virtual]`

Implements CitrixMobility.ISession.

virtual int CitrixMobility.CitrixMobileClass.SetSupportedOrientations ( [In] CMP_SUPPORTED_ORIENTATIONS supportedOrientations ) [virtual]

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.SetViewport	(	[In] short	flags,
		[In] short	zoomFactor,
		[In] ref CMP_DISPLAY_RECT	serverViewport
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.SetViewportOrigin	(	[In] ref CMP_DISPLAY_POINT	pt,
		[In] short	viewportFlags
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.ShowKeyboard ( [In] ref CMP_KEYBOARD_STATE kybdState ) [virtual]

Show the display keyboard with the given properties.

Parameters:

kybdState - keyboard selection and other keyboard settings

Returns:: CMPRESULT

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.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
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.ShowPicker	(	[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	ControlId,
		[In] ref CMP_DISPLAY_RECT	rect,
		[In] int	selectedIndex,
		[In, MarshalAs(UnmanagedType.BStr)] string	bstrList,
		[In, MarshalAs(UnmanagedType.BStr)] string	bstrTitle
	)		`[virtual]`

Implements CitrixMobility.IPicker.

virtual int CitrixMobility.CitrixMobileClass.StartPhoneCall	(	[In, MarshalAs(UnmanagedType.BStr)] string	phoneNumber,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	phoneCallId
	)		`[virtual]`

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

Implements CitrixMobility.ICMPDispatch.

virtual int CitrixMobility.CitrixMobileClass.TakePicture	(	[In] CMP_IMAGE_FORMAT	imgType,
		[In, ComAliasName("CitrixMobility.CMP_UNIQUE_ID")] int	imageID
	)		`[virtual]`