Mobile SDK for Windows Apps2.0
Transforming Windows apps into Mobile apps
cmpenum.h File Reference

CMPAPI - Enumeration definitions for Citrix Mobility Pack. More...

#include <cmpresult.h>

Go to the source code of this file.

Defines

#define CMP_PICKER_CONTROL_ALL_FLAGS   0x0003
 All picker control support flags.
#define IMAGE_FORMAT_SUPPORT_ALL   0x0003
 Combination of all image formats.
#define CMP_VIEWPORT_VALID_FLAG_ALL   0x0007
 Combination of all valid viewport flags.

Enumerations

enum  CMP_ORIENTATION_POSITION {
  CMP_ORIENTATION_UNKNOWN = 0x0000, CMP_ORIENTATION_PORTRAIT = 0x0001, CMP_ORIENTATION_PORTRAIT_UPSIDE_DOWN = 0x0002, CMP_ORIENTATION_LANDSCAPE_LEFT = 0x0003,
  CMP_ORIENTATION_LANDSCAPE_RIGHT = 0x0004
}
 Orientation positions for mobile device. More...
enum  CMP_ORIENTATION_FLAG { CMP_ORIENTATION_FLAG_LOCK = 0x0001, CMP_ORIENTATION_FLAG_FOLLOW_SENSOR = 0x0002 }
 Orientation flags. More...
enum  CMP_PICKER_SUPPORT_FLAGS { CMP_PICKER_CONTROL_FLAG_SUPPORT = 0x0001, CMP_PICKER_CONTROL_FLAG_TITLE_SUPPORT = 0x0002 }
 Picker control feature flags. More...
enum  CMP_KEYBOARD_FLAGS {
  CMP_KYBD_FLAG_PHYSICAL = 0x0001, CMP_KYBD_FLAG_VISIBLE = 0x0002, CMP_KYBD_FLAG_EXT_FLAG = 0x0004, CMP_KYBD_FLAG_USE_RECT = 0x0008,
  CMP_KYBD_FLAG_AUTO_CORRECT = 0x0010, CMP_KYBD_FLAG_AUTO_CAPITAL = 0x0020, CMP_KYBD_FLAG_RETURN_KEY_TYPE = 0x0040
}
 Keyboard flag options. More...
enum  CMP_KEYBOARD_TYPE {
  CMP_KYBD_TYPE_UNKNOWN = 0x0000, CMP_KYBD_TYPE_PHYSICAL = 0x0001, CMP_KYBD_TYPE_STANDARD = 0x0002, CMP_KYBD_TYPE_NUMBER_PAD = 0x0003,
  CMP_KYBD_TYPE_PHONE_PAD = 0x0004, CMP_KYBD_TYPE_URL = 0x0005, CMP_KYBD_TYPE_EMAIL = 0x0006, CMP_KYBD_TYPE_PHONE_NAME = 0x0007,
  CMP_KYBD_TYPE_NUMBERS_PUNC = 0x0008, CMP_KYBD_TYPE_DECIMAL_POINT = 0x0009
}
 Type of keyboards which can be selected. More...
enum  CMP_KEYBOARD_AUTOCAPS { CMP_KYBD_AUTO_CAPITAL_NONE = 0x0000, CMP_KYBD_AUTO_CAPITAL_WORDS = 0x0001, CMP_KYBD_AUTO_CAPITAL_SENTENCES = 0x0002, CMP_KYBD_AUTO_CAPITAL_LETTERS = 0x0003 }
 Auto capitalization options for keyboard. More...
enum  CMP_KEYBOARD_RETURNKEY {
  CMP_KYBD_RETURN_KEY_DEFAULT = 0x0001, CMP_KYBD_RETURN_KEY_GO = 0x0002, CMP_KYBD_RETURN_KEY_GOOGLE = 0x0003, CMP_KYBD_RETURN_KEY_JOIN = 0x0004,
  CMP_KYBD_RETURN_KEY_NEXT = 0x0005, CMP_KYBD_RETURN_KEY_ROUTE = 0x0006, CMP_KYBD_RETURN_KEY_SEARCH = 0x0007, CMP_KYBD_RETURN_KEY_SEND = 0x0008,
  CMP_KYBD_RETURN_KEY_DONE = 0x0009
}
 Types of return key text for keyboard. More...
enum  CMP_SCROLL_MODE { CMP_SCROLLMODE_MOUSEWHEEL = 0x0001, CMP_SCROLLMODE_DRAG = 0x0002, CMP_SCROLLMODE_PAN = 0x0003 }
 Scroll mode options. More...
enum  CMP_BUTTON_ID { CMP_BUTTON_BACK = 0x0001, CMP_BUTTON_SEARCH = 0x0002, CMP_BUTTON_HOME = 0x0003, CMP_BUTTON_MENU = 0x0004 }
 Button identification. More...
enum  CMP_BUTTON_TARGET { CMP_BUTTON_TARGET_HOST = 0x0001, CMP_BUTTON_TARGET_CLIENT = 0x0002 }
 Destination for button events. More...
enum  CMP_IMAGE_FORMAT { CMP_IMAGE_FORMAT_JPEG = 0x0001, CMP_IMAGE_FORMAT_PNG = 0x0002 }
 Image formats for Take Picture. More...
enum  CMP_SUPPORTED_ORIENTATIONS {
  CMP_SO_ALL = 0x0F, CMP_SO_LANDSCAPE = 0x03, CMP_SO_PORTRAIT = 0x0C, CMP_SO_LANDSCAPE_LEFT = 0x01,
  CMP_SO_LANDSCAPE_RIGHT = 0x02, CMP_SO_PORTRAIT_UP = 0x04, CMP_SO_PORTRAIT_DOWN = 0x08, CMP_SO_NO_PORTRAIT_DOWN = 0x07
}
 Application can select which orientations it will support. More...
enum  CMP_COMPONENT_ID {
  COMPONENT_COMMON = 0x0000, COMPONENT_BUTTON = 0x0001, COMPONENT_CAMERA = 0x0002, COMPONENT_RECEIVER = 0x0003,
  COMPONENT_DEVICE = 0x0004, COMPONENT_DISPLAY = 0x0005, COMPONENT_KEYBOARD = 0x0007, COMPONENT_MESSAGE = 0x0008,
  COMPONENT_PHONE = 0x0009, COMPONENT_PICKER = 0x000A, COMPONENT_EVENT = 0x000C, COMPONENT_CHANNEL = 0x000D,
  COMPONENT_NOTIFY = 0x000E, COMPONENT_SESSION = 0x000F, COMPONENT_CAPS = 0x0010, COMPONENT_CONTROLS = 0x0011,
  COMPONENT_GVCH = 0x0012, COMPONENT_VDO = 0x0013, COMPONENT_CAPTURE = 0x0014, COMPONENT_EMULATOR = 0x0015
}
 Component Ids used with error codes. More...
enum  CMP_ERROR_ID {
  CMP_NO_ERROR = STATUS_CODE(COMPONENT_COMMON, 0x0000), CMP_ERROR_INVALID_FUNCTION = STATUS_CODE(COMPONENT_COMMON, 0x0001), CMP_ERROR_NOT_FOUND = STATUS_CODE(COMPONENT_COMMON, 0x0002), CMP_ERROR_NOT_SUPPORTED = STATUS_CODE(COMPONENT_COMMON, 0x0003),
  CMP_ERROR_INVALID_PARAMETER = STATUS_CODE(COMPONENT_COMMON, 0x0004), CMP_ERROR_NULL_PARAMETER = STATUS_CODE(COMPONENT_COMMON, 0x0005), CMP_ERROR_COM_INITIALIZE = STATUS_CODE(COMPONENT_COMMON, 0x0006), CMP_ERROR_COM_CREATE_INSTANCE = STATUS_CODE(COMPONENT_COMMON, 0x0007),
  CMP_ERROR_CONVERTING_UTF8 = STATUS_CODE(COMPONENT_COMMON, 0x0008), CMP_ERROR_CONVERTING_UTF16_TO_UTF8 = STATUS_CODE(COMPONENT_COMMON, 0x0009), CMP_ERROR_MISSING_INTERFACE = STATUS_CODE(COMPONENT_COMMON, 0x000A), CMP_ERROR_INVALID_SIZE = STATUS_CODE(COMPONENT_COMMON, 0x000B),
  CMP_ERROR_ACCESS_DENIED = STATUS_CODE(COMPONENT_COMMON, 0x000C), CMP_ERROR_REGISTERING_INTERFACES = STATUS_CODE(COMPONENT_COMMON, 0x000D), CMP_ERROR_TIMEOUT = STATUS_CODE(COMPONENT_COMMON, 0x000E), CMP_ERROR_UTF8_TO_UTF16_LENGTH = STATUS_CODE(COMPONENT_COMMON, 0x000F),
  CMP_ERROR_UTF16_TO_UTF8_LENGTH = STATUS_CODE(COMPONENT_COMMON, 0x0010), CMP_ERROR_BUFFER_TOO_SMALL = STATUS_CODE(COMPONENT_COMMON, 0x0011), CMP_ERROR_NOT_ENOUGH_MEMORY = STATUS_CODE(COMPONENT_COMMON, 0x0012), CMP_ERROR_NOT_FOREGROUND_WINDOW = STATUS_CODE(COMPONENT_COMMON, 0x0013),
  CMP_ERROR_SESSION_NOT_FOUND = STATUS_CODE(COMPONENT_COMMON, 0x0014), CMP_ERROR_SYSTEM_HOOK_FAILED = STATUS_CODE(COMPONENT_COMMON, 0x0015), CMP_ERROR_NOT_CONNECTED = STATUS_CODE(COMPONENT_COMMON, 0x0016), CMP_ERROR_INVALID_HANDLE = STATUS_CODE(COMPONENT_COMMON, 0x0017),
  CMP_ERROR_GETTING_SAFEARRAY_ELEMENT = STATUS_CODE(COMPONENT_COMMON, 0x0018), CMP_ERROR_BUFFER_OVERFLOW = STATUS_CODE(COMPONENT_COMMON, 0x0019), CMP_ERROR_PACKET_FIELD = STATUS_CODE(COMPONENT_COMMON, 0x001A), CMP_ERROR_UNRECOGNIZED_STORAGE_PATH = STATUS_CODE(COMPONENT_COMMON, 0x001B),
  CMP_ERROR_PACKET_TOO_SMALL = STATUS_CODE(COMPONENT_COMMON, 0x001C), CMP_ERROR_GETTING_API_VERSION = STATUS_CODE(COMPONENT_COMMON, 0x001D), CMP_ERROR_CREATING_OBJECT = STATUS_CODE(COMPONENT_COMMON, 0x001E), CMP_ERROR_INVALID_PACKET_FIELD_OFFSET = STATUS_CODE(COMPONENT_COMMON, 0x001F),
  CMP_ERROR_INVALID_PACKET_FIELD_LENGTH = STATUS_CODE(COMPONENT_COMMON, 0x0020), CMP_ERROR_PACKET_TOO_BIG = STATUS_CODE(COMPONENT_COMMON, 0x0021), CMP_ERROR_FILE_NOT_FOUND = STATUS_CODE(COMPONENT_COMMON, 0x0022), CMP_ERROR_INTERNAL_ERROR = STATUS_CODE(COMPONENT_COMMON, 0x0023),
  CMP_ERROR_SERVICE_DOES_NOT_EXIST = STATUS_CODE(COMPONENT_COMMON, 0x0024), CMP_ERROR_GET_FILE_PATH = STATUS_CODE(COMPONENT_COMMON, 0x0025), CMP_ERROR_BIND_RESPONSE_PACKET = STATUS_CODE(COMPONENT_COMMON, 0x0026), CMP_ERROR_PICKER_SHOW_PACKET = STATUS_CODE(COMPONENT_COMMON, 0x0027),
  CMP_ERROR_INVALID_PROCESS_ID = STATUS_CODE(COMPONENT_COMMON, 0x0028), CMP_ERROR_INSUFFICIENT_BUFFER = STATUS_CODE(COMPONENT_COMMON, 0x0029), CMP_ERROR_INVALID_FLAGS = STATUS_CODE(COMPONENT_COMMON, 0x002A), CMP_ERROR_NO_UNICODE_TRANSLATION = STATUS_CODE(COMPONENT_COMMON, 0x002B),
  CMP_ERROR_CLIENT_DRIVE_UNAVAILABLE = STATUS_CODE(COMPONENT_COMMON, 0x002C), CMP_ERROR_SD_CARD_UNMOUNTED = STATUS_CODE(COMPONENT_COMMON, 0x002D), CMP_ERROR_NETWORK_ENUMERATE = STATUS_CODE(COMPONENT_COMMON, 0x002E), CMP_ERROR_NOT_CONTAINER = STATUS_CODE(COMPONENT_COMMON, 0x002F),
  CMP_ERROR_NO_NETWORK = STATUS_CODE(COMPONENT_COMMON, 0x0030), CMP_ERROR_INVALID_ADDRESS = STATUS_CODE(COMPONENT_COMMON, 0x0031), CMP_ERROR_NO_MORE_ITEMS = STATUS_CODE(COMPONENT_COMMON, 0x0032), CMP_ERROR_MORE_DATA = STATUS_CODE(COMPONENT_COMMON, 0x0033),
  CMP_ERROR_LOADING_DLL = STATUS_CODE(COMPONENT_COMMON, 0x0034), CMP_ERROR_INTERFACE_NOT_AVAILABLE = STATUS_CODE(COMPONENT_COMMON, 0x0035), CMP_ERROR_GENERATING_HASH_VALUE = STATUS_CODE(COMPONENT_COMMON, 0x0036), CMP_ERROR_GENERATING_RANDOM_DATA = STATUS_CODE(COMPONENT_COMMON, 0x0037),
  CMP_ERROR_CREATING_INTERNAL_CLASS = STATUS_CODE(COMPONENT_COMMON, 0x0038), CMP_ERROR_CREATING_INTERNAL_WINDOW = STATUS_CODE(COMPONENT_COMMON, 0x0039), CMP_ERROR_CREATING_THREAD = STATUS_CODE(COMPONENT_COMMON, 0x003A), CMP_ERROR_CLASS_ALREADY_EXISTS = STATUS_CODE(COMPONENT_COMMON, 0x003B),
  CMP_ERROR_PREVIOUS_REQUEST_PENDING = STATUS_CODE(COMPONENT_COMMON, 0x003C), CMP_BUTTON_NO_ERROR = STATUS_CODE(COMPONENT_BUTTON, 0x0000), CMP_ERROR_UNSUPPORTED_BUTTON_ID = STATUS_CODE(COMPONENT_BUTTON, 0x0001), CMP_ERROR_SET_BUTTON_TARGET = STATUS_CODE(COMPONENT_BUTTON, 0x0002),
  CMP_ERROR_GET_BUTTON_TARGET = STATUS_CODE(COMPONENT_BUTTON, 0x0003), CMP_ERROR_GET_BUTTON_TARGET_TIMEOUT = STATUS_CODE(COMPONENT_BUTTON, 0x0004), CMP_CAMERA_NO_ERROR = STATUS_CODE(COMPONENT_CAMERA, 0x0000), CMP_ERROR_TAKE_PICTURE = STATUS_CODE(COMPONENT_CAMERA, 0x0001),
  CMP_ERROR_NO_CAMERA = STATUS_CODE(COMPONENT_CAMERA, 0x0002), CMP_ERROR_UNSUPPORTED_IMAGE_FORMAT = STATUS_CODE(COMPONENT_CAMERA, 0x0003), CMP_ERROR_GET_PICTURE_FILENAME = STATUS_CODE(COMPONENT_CAMERA, 0x0004), CMP_ERROR_GET_PICTURE_FILENAME_TIMEOUT = STATUS_CODE(COMPONENT_CAMERA, 0x0005),
  CMP_ERROR_CANCEL_TAKE_PICTURE = STATUS_CODE(COMPONENT_CAMERA, 0x0006), CMP_ERROR_REMOVE_PICTURE = STATUS_CODE(COMPONENT_CAMERA, 0x0007), CMP_ERROR_GET_PICTURE_STATE_TIMEOUT = STATUS_CODE(COMPONENT_CAMERA, 0x0008), CMP_ERROR_GET_PICTURE_STATE = STATUS_CODE(COMPONENT_CAMERA, 0x0009),
  CMP_ERROR_ALREADY_TAKING_PICTURE = STATUS_CODE(COMPONENT_CAMERA, 0x000A), CMP_DEVICE_NO_ERROR = STATUS_CODE(COMPONENT_DEVICE, 0x0000), CMP_ERROR_INVALID_PROP_ID = STATUS_CODE(COMPONENT_DEVICE, 0x0001), CMP_ERROR_INVALID_PROPERTY_TYPE = STATUS_CODE(COMPONENT_DEVICE, 0x0002),
  CMP_ERROR_GET_DEVICE_STRING = STATUS_CODE(COMPONENT_DEVICE, 0x0003), CMP_ERROR_GET_DEVICE_STRING_TIMEOUT = STATUS_CODE(COMPONENT_DEVICE, 0x0004), CMP_ERROR_GET_DEVICE_BOOL = STATUS_CODE(COMPONENT_DEVICE, 0x0005), CMP_ERROR_GET_DEVICE_BOOL_TIMEOUT = STATUS_CODE(COMPONENT_DEVICE, 0x0006),
  CMP_ERROR_UNSUPPORTED_PROP_ID = STATUS_CODE(COMPONENT_DEVICE, 0x0007), CMP_DISPLAY_NO_ERROR = STATUS_CODE(COMPONENT_DISPLAY, 0x0000), CMP_ERROR_SET_SCROLL_MODE = STATUS_CODE(COMPONENT_DISPLAY, 0x0001), CMP_ERROR_SET_ORIENTATION = STATUS_CODE(COMPONENT_DISPLAY, 0x0002),
  CMP_ERROR_GET_ORIENTATION = STATUS_CODE(COMPONENT_DISPLAY, 0x0003), CMP_ERROR_SET_VIEWPORT_ORIGIN = STATUS_CODE(COMPONENT_DISPLAY, 0x0004), CMP_ERROR_GET_ORIENTATION_TIMEOUT = STATUS_CODE(COMPONENT_DISPLAY, 0x0005), CMP_ERROR_GET_SCROLL_MODE = STATUS_CODE(COMPONENT_DISPLAY, 0x0006),
  CMP_ERROR_GET_SCROLL_MODE_TIMEOUT = STATUS_CODE(COMPONENT_DISPLAY, 0x0007), CMP_ERROR_GET_VIEWPORT_ORIGIN = STATUS_CODE(COMPONENT_DISPLAY, 0x0008), CMP_ERROR_GET_VIEWPORT_ORIGIN_TIMEOUT = STATUS_CODE(COMPONENT_DISPLAY, 0x0009), CMP_ERROR_GET_DISPLAY_SETTINGS = STATUS_CODE(COMPONENT_DISPLAY, 0x000A),
  CMP_ERROR_GET_DISPLAY_SETTINGS_TIMEOUT = STATUS_CODE(COMPONENT_DISPLAY, 0x000B), CMP_ERROR_GET_VIEWPORT = STATUS_CODE(COMPONENT_DISPLAY, 0x000C), CMP_ERROR_GET_VIEWPORT_TIMEOUT = STATUS_CODE(COMPONENT_DISPLAY, 0x000D), CMP_ERROR_SET_VIEWPORT = STATUS_CODE(COMPONENT_DISPLAY, 0x000E),
  CMP_ERROR_SET_ORIENTATION_SUPPORTED = STATUS_CODE(COMPONENT_DISPLAY, 0x000F), CMP_ERROR_GET_ORIENTATION_SUPPORTED = STATUS_CODE(COMPONENT_DISPLAY, 0x0010), CMP_ERROR_GET_ORIENTATION_SUPPORTED_TIMEOUT = STATUS_CODE(COMPONENT_DISPLAY, 0x0011), CMP_ERROR_VIEWPORT_ORIGIN_LOCKED = STATUS_CODE(COMPONENT_DISPLAY, 0x0012),
  CMP_ERROR_VIEWPORT_LOCKED = STATUS_CODE(COMPONENT_DISPLAY, 0x0013), CMP_KEYBOARD_NO_ERROR = STATUS_CODE(COMPONENT_KEYBOARD, 0x0000), CMP_ERROR_SHOWING_KEYBOARD = STATUS_CODE(COMPONENT_KEYBOARD, 0x0001), CMP_ERROR_HIDING_KEYBOARD = STATUS_CODE(COMPONENT_KEYBOARD, 0x0002),
  CMP_ERROR_GET_KEYBOARD_STATE = STATUS_CODE(COMPONENT_KEYBOARD, 0x0003), CMP_ERROR_GET_KEYBOARD_STATE_TIMEOUT = STATUS_CODE(COMPONENT_KEYBOARD, 0x0004), CMP_SMS_NO_ERROR = STATUS_CODE(COMPONENT_MESSAGE, 0x0000), CMP_ERROR_SEND_SMS = STATUS_CODE(COMPONENT_MESSAGE, 0x0001),
  CMP_ERROR_ALREADY_SENDING_SMS = STATUS_CODE(COMPONENT_MESSAGE, 0x0002), CMP_PHONE_NO_ERROR = STATUS_CODE(COMPONENT_PHONE, 0x0000), CMP_ERROR_START_PHONE_CALL = STATUS_CODE(COMPONENT_PHONE, 0x0001), CMP_ERROR_INVALID_PHONE_NUMBER = STATUS_CODE(COMPONENT_PHONE, 0x0002),
  CMP_ERROR_PHONE_NUMBER_TOO_LONG = STATUS_CODE(COMPONENT_PHONE, 0x0003), CMP_ERROR_ALREADY_STARTING_CALL = STATUS_CODE(COMPONENT_PHONE, 0x0004), CMP_PICKER_NO_ERROR = STATUS_CODE(COMPONENT_PICKER, 0x0000), CMP_ERROR_SHOW_PICKER_CONTROL = STATUS_CODE(COMPONENT_PICKER, 0x0001),
  CMP_ERROR_HIDE_PICKER_CONTROL = STATUS_CODE(COMPONENT_PICKER, 0x0002), CMP_ERROR_GET_PICKER_STATE = STATUS_CODE(COMPONENT_PICKER, 0x0003), CMP_ERROR_GET_PICKER_STATE_TIMEOUT = STATUS_CODE(COMPONENT_PICKER, 0x0004), CMP_ERROR_PICKER_TITLE_TOO_LONG = STATUS_CODE(COMPONENT_PICKER, 0x0005),
  CMP_ERROR_PICKER_LIST_TOO_BIG = STATUS_CODE(COMPONENT_PICKER, 0x0006), CMP_EVENT_NO_ERROR = STATUS_CODE(COMPONENT_EVENT, 0x0000), CMP_ERROR_EVENT_UNKNOWN_EVENT_ID = STATUS_CODE(COMPONENT_EVENT, 0x0001), CMP_ERROR_EVENT_HOOKING_FAILURE = STATUS_CODE(COMPONENT_EVENT, 0x0002),
  CMP_CHANNEL_NO_ERROR = STATUS_CODE(COMPONENT_CHANNEL, 0x0000), CMP_ERROR_OPEN_CHANNEL = STATUS_CODE(COMPONENT_CHANNEL, 0x0001), CMP_ERROR_BIND_FAILED = STATUS_CODE(COMPONENT_CHANNEL, 0x0002), CMP_ERROR_NOT_BOUND = STATUS_CODE(COMPONENT_CHANNEL, 0x0003),
  CMP_ERROR_UNBIND_FAILED = STATUS_CODE(COMPONENT_CHANNEL, 0x0005), CMP_ERROR_BIND_TIMEOUT = STATUS_CODE(COMPONENT_CHANNEL, 0x0006), CMP_NOTIFY_NO_ERROR = STATUS_CODE(COMPONENT_NOTIFY, 0x0000), CMP_ERROR_NOTIFY_TEXT_TOO_LONG = STATUS_CODE(COMPONENT_NOTIFY, 0x0001),
  CMP_ERROR_NOTIFY_USER = STATUS_CODE(COMPONENT_NOTIFY, 0x0002), CMP_SESSION_NO_ERROR = STATUS_CODE(COMPONENT_SESSION, 0x0000), CMP_ERROR_NO_SESSION = STATUS_CODE(COMPONENT_SESSION, 0x0001), CMP_ERROR_SESSION_ALREADY_OPEN = STATUS_CODE(COMPONENT_SESSION, 0x0002),
  CMP_ERROR_CREATING_SESSION = STATUS_CODE(COMPONENT_SESSION, 0x0003), CMP_ERROR_SESSION_OPTION_INVALID = STATUS_CODE(COMPONENT_SESSION, 0x0004), CMP_ERROR_REGISTER_CMP_PROCESS = STATUS_CODE(COMPONENT_SESSION, 0x0005), CMP_ERROR_UNREGISTER_CMP_PROCESS = STATUS_CODE(COMPONENT_SESSION, 0x0006),
  CMP_CAPABILITIES_NO_ERROR = STATUS_CODE(COMPONENT_CAPS, 0x0000), CMP_ERROR_CAPABILITY_NOT_SUPPORTED = STATUS_CODE(COMPONENT_CAPS, 0x0001), CMP_ERROR_NO_CAPABILITIES = STATUS_CODE(COMPONENT_CAPS, 0x0002), CMP_ERROR_CAPABILITY_VALUE_NOT_FOUND = STATUS_CODE(COMPONENT_CAPS, 0x0003),
  CMP_ERROR_CAPABILITY_NOT_FOUND = STATUS_CODE(COMPONENT_CAPS, 0x0004), CMP_ERROR_CAPABILITY_TYPE_MISMATCH = STATUS_CODE(COMPONENT_CAPS, 0x0005), CMP_ERROR_CAPABILITY_SIZE_MISMATCH = STATUS_CODE(COMPONENT_CAPS, 0x0006), CMP_ERROR_CAPABILITY_INVALID_VALUE_TYPE = STATUS_CODE(COMPONENT_CAPS, 0x0007),
  CMP_ERROR_CAPABILITY_VALUE_OVERFLOW = STATUS_CODE(COMPONENT_CAPS, 0x0008), CMP_CONTROLS_NO_ERROR = STATUS_CODE(COMPONENT_CONTROLS, 0x0000), CMP_ERROR_ENABLE_OR_DISABLE_CONTROLS = STATUS_CODE(COMPONENT_CONTROLS, 0x0001), CMP_ERROR_GET_CONTROLS_FLAGS_TIMEOUT = STATUS_CODE(COMPONENT_CONTROLS, 0x0002),
  CMP_ERROR_GET_CONTROLS_FLAGS = STATUS_CODE(COMPONENT_CONTROLS, 0x0003), CMP_GVCH_NO_ERROR = STATUS_CODE(COMPONENT_GVCH, 0x0000), CMP_ERROR_GVCH_IO_DATA_OUT_OF_BOUNDS = STATUS_CODE(COMPONENT_GVCH, 0x0001), CMP_ERROR_GVCH_IO_DATA_STRING_TOO_BIG = STATUS_CODE(COMPONENT_GVCH, 0x0002),
  CMP_ERROR_GVCH_IO_DATA_STRING_INVALID = STATUS_CODE(COMPONENT_GVCH, 0x0003), CMP_ERROR_GVCH_IO_DATA_DATA_TOO_BIG = STATUS_CODE(COMPONENT_GVCH, 0x0004), CMP_ERROR_GVCH_IO_DATA_HEADER_TOO_SMALL = STATUS_CODE(COMPONENT_GVCH, 0x0005), CMP_ERROR_GVCH_INVALID_STATE_FOR_CALL = STATUS_CODE(COMPONENT_GVCH, 0x0006),
  CMP_ERROR_GVCH_INVALID_VC_NAME = STATUS_CODE(COMPONENT_GVCH, 0x0007), CMP_ERROR_GVCH_NOT_CONNECTED_STATE = STATUS_CODE(COMPONENT_GVCH, 0x0008), CMP_ERROR_GVCH_INVALID_SESSION = STATUS_CODE(COMPONENT_GVCH, 0x0009), CMP_ERROR_GVCH_INVALID_VC_MGR = STATUS_CODE(COMPONENT_GVCH, 0x000A),
  CMP_VDO_NO_ERROR = STATUS_CODE(COMPONENT_VDO, 0x0000), CMP_ERROR_VDO_CONTEXT_SET = STATUS_CODE(COMPONENT_VDO, 0x0001), CMP_ERROR_VDO_CONTEXT_ACTIVATE = STATUS_CODE(COMPONENT_VDO, 0x0002), CMP_CAPTURE_NO_ERROR = STATUS_CODE(COMPONENT_CAPTURE, 0x0000),
  CMP_ERROR_CAPTURE_PICTURE = STATUS_CODE(COMPONENT_CAPTURE, 0x0001), CMP_ERROR_CAPTURE_VIDEO = STATUS_CODE(COMPONENT_CAPTURE, 0x0002), CMP_ERROR_CAPTURE_AUDIO = STATUS_CODE(COMPONENT_CAPTURE, 0x0003), CMP_ERROR_CAPTURE_OPTIONS_TOO_LONG = STATUS_CODE(COMPONENT_CAPTURE, 0x0004),
  CMP_ERROR_CAPTURE_REMOVE = STATUS_CODE(COMPONENT_CAPTURE, 0x0005), CMP_ERROR_CAPTURE_CANCEL = STATUS_CODE(COMPONENT_CAPTURE, 0x0006), CMP_ERROR_AUDIO_RECORDING_DISABLED = STATUS_CODE(COMPONENT_CAPTURE, 0x0007), CMP_ERROR_ALREADY_CAPTURING = STATUS_CODE(COMPONENT_CAPTURE, 0x0008),
  CMP_ERROR_EMULATOR_SIMULATED_FAILURE = STATUS_CODE(COMPONENT_EMULATOR, 0x0001), CMP_ERROR_EMULATOR_PIPE_NOT_FOUND = STATUS_CODE(COMPONENT_EMULATOR, 0x0002), CMP_ERROR_EMULATOR_PIPE_BROKEN = STATUS_CODE(COMPONENT_EMULATOR, 0x0003), CMP_ERROR_EMULATOR_AUTO_LAUNCH = STATUS_CODE(COMPONENT_EMULATOR, 0x0004)
}
 CMPRESULT error definitions. More...
enum  CMP_DEV_STRING_PROP_ID {
  CMP_DEVICE_STRING_PROP_ID_FIRST = 0x0001, CMP_DEVICE_MANUFACTURER = 0x0001, CMP_DEVICE_MODEL = 0x0002, CMP_DEVICE_SERIAL_NUMBER = 0x0003,
  CMP_DEVICE_GIVEN_NAME = 0x0004, CMP_DEVICE_WIFI_MAC_ADDRESS = 0x0005, CMP_DEVICE_BLUETOOTH_MAC_ADDRESS = 0x0006, CMP_DEVICE_STRING_PROP_ID_LAST = 0x0006
}
 device string property definitions. More...
enum  CMP_DEV_BOOL_PROP_ID {
  CMP_DEVICE_BOOL_PROP_ID_FIRST = 0x1001, CMP_DEVICE_3G = 0x1001, CMP_DEVICE_4G = 0x1002, CMP_DEVICE_ACCELEROMETER = 0x1003,
  CMP_DEVICE_AUDIO_OUTPUT = 0x1004, CMP_DEVICE_BATTERY = 0x1005, CMP_DEVICE_BLUETOOTH = 0x1006, CMP_DEVICE_CAMERA = 0x1007,
  CMP_DEVICE_CAMERA_BACK = 0x1008, CMP_DEVICE_CAMERA_FRONT = 0x1009, CMP_DEVICE_COMPASS = 0x100A, CMP_DEVICE_COMPONENT_VIDEO = 0x100B,
  CMP_DEVICE_COMPOSITE_VIDEO = 0x100C, CMP_DEVICE_GSM = 0x100D, CMP_DEVICE_GPS = 0x100E, CMP_DEVICE_GYROSCOPE = 0x100F,
  CMP_DEVICE_HDMI_VIDEO = 0x1010, CMP_DEVICE_MICRO_SD_CARD = 0x1011, CMP_DEVICE_MICROPHONE = 0x1012, CMP_DEVICE_MMS = 0x1013,
  CMP_DEVICE_MOUSE = 0x1014, CMP_DEVICE_MULTI_TOUCH = 0x1015, CMP_DEVICE_ORIENTATION_CHANGES = 0x1016, CMP_DEVICE_PHYSICAL_KEYBOARD = 0x1017,
  CMP_DEVICE_SENSOR_LIGHT = 0x1018, CMP_DEVICE_SIM = 0x1019, CMP_DEVICE_SMS = 0x101A, CMP_DEVICE_TOUCH_SCREEN = 0x101B,
  CMP_DEVICE_TRACKBALL = 0x101C, CMP_DEVICE_WIFI = 0x101D, CMP_DEVICE_WIRELESS_PHONE = 0x101E, CMP_DEVICE_BOOL_PROP_ID_LAST = 0x101E
}
 device boolean property definitions. More...
enum  CMP_PICTURE_STATE { CMP_PICTURE_STATE_UNAVAILABLE = 0, CMP_PICTURE_STATE_READY = 1 }
 state of the specified picture. More...
enum  CMP_SESSION_STATE {
  CMP_SESSION_STATE_INITIAL = 0, CMP_SESSION_STATE_CONNECTED = 1, CMP_SESSION_STATE_DISCONNECTED = 2, CMP_SESSION_STATE_LOCKED = 3,
  CMP_SESSION_STATE_UNLOCKED = 4, CMP_SESSION_STATE_LOGGED_ON = 5, CMP_SESSION_STATE_LOGGED_OFF = 6, CMP_SESSION_STATE_CONSOLE = 7
}
 State of the session. More...
enum  CMP_CHANNEL_STATE {
  CMP_CHANNEL_STATE_INITIAL = 0, CMP_CHANNEL_STATE_CONNECTED = 1, CMP_CHANNEL_STATE_DISCONNECTED = 2, CMP_CHANNEL_STATE_BOUND = 3,
  CMP_CHANNEL_STATE_BIND_FAILURE = 4
}
 State of the channel. More...
enum  CMP_EVENT_ID {
  CMP_EVENT_APP_FOREGROUND = 0x0001, CMP_EVENT_APP_BACKGROUND = 0x0002, CMP_EVENT_FOREGROUND_APP_CHANGED = 0x0003, CMP_EVENT_BUTTON_PRESSED = 0xF800,
  CMP_EVENT_DISPLAY_SETTINGS_CHANGED = 0xF801, CMP_EVENT_ORIENTATION_CHANGED = 0xF802, CMP_EVENT_SCROLL_MODE_CHANGED = 0xF803, CMP_EVENT_KEYBOARD_STATE_CHANGED = 0xF804,
  CMP_EVENT_VIEWPORT_CHANGED = 0xF805, CMP_EVENT_VIEWPORT_ORIGIN_CHANGED = 0xF806, CMP_EVENT_BUTTON_TARGET_CHANGED = 0xF807, CMP_EVENT_CONTROL_STATE_CHANGED = 0xF808,
  CMP_EVENT_SMS_STARTED = 0xF809, CMP_EVENT_PHONE_CALL_STARTED = 0xF80B, CMP_EVENT_PICKER_CONTROL_STATE_CHANGED = 0xF80C, CMP_EVENT_CAMERA_PICTURE_TAKEN = 0xF80D,
  CMP_EVENT_FILTER_CHANGED = 0xF810, CMP_EVENT_USER_NOTIFIED = 0xF811, CMP_EVENT_CAMERA_PICTURE_REMOVED = 0xF812, CMP_EVENT_SESSION_STATE_CHANGED = 0xF813,
  CMP_EVENT_CHANNEL_STATE_CHANGED = 0xF814, CMP_EVENT_PICTURE_CAPTURED = 0xF815, CMP_EVENT_VIDEO_CAPTURED = 0xF816, CMP_EVENT_AUDIO_CAPTURED = 0xF817,
  CMP_EVENT_SUPPORTED_ORIENTATIONS_CHANGED = 0xF818, CMP_EVENT_CAPTURE_MEDIA_REMOVED = 0xF81A, CMP_EVENT_ALL = 0xFFFF
}
 Event identifiers. More...
enum  CMP_NOTIFICATION_FLAGS {
  CMP_NOTIFICATION_FLAG_LIGHT = 0x0001, CMP_NOTIFICATION_FLAG_VIBRATE = 0x0002, CMP_NOTIFICATION_FLAG_AUDIO = 0x0004, CMP_NOTIFICATION_FLAG_TEXT = 0x0008,
  CMP_NOTIFICATION_ALL_FLAGS = 0x000F
}
 Notification option flags. More...
enum  CMP_IMAGE_FORMAT_SUPPORT { CMP_IMAGE_FORMAT_JPEG_SUPPORT = 0x0001, CMP_IMAGE_FORMAT_PNG_SUPPORT = 0x0002 }
 Image formats supported by CMP. More...
enum  CMP_SESSION_OPTION { CMP_SESSION_OPTION_IGNORE_FOREGROUND_CHECK = 0x0001, CMP_SESSION_OPTION_DISABLE_CACHE = 0x0002 }
 Option identifiers for changing values for session. More...
enum  CMP_DEVICE_OS {
  CMP_DEVICE_OS_UNKNOWN = 0x0000, CMP_DEVICE_OS_ANDROID = 0x0001, CMP_DEVICE_OS_IOS = 0x0002, CMP_DEVICE_OS_BLACKBERRY = 0x0003,
  CMP_DEVICE_OS_WINDOWS_MOBILE = 0x0004, CMP_DEVICE_OS_WINDOWS_PHONE = 0x0005, CMP_DEVICE_OS_WEBOS = 0x0006, CMP_DEVICE_OS_QNX = 0x0007,
  CMP_DEVICE_OS_BADA = 0x0008, CMP_DEVICE_OS_MEEGO = 0x0009, CMP_DEVICE_OS_WINDOWS = 0x000A, CMP_DEVICE_OS_OSX = 0x000B,
  CMP_DEVICE_OS_LINUX = 0x000C
}
 Device operating system identifiers. More...
enum  CMP_DEVICE_TYPE {
  CMP_DEVICE_TYPE_UNKNOWN = 0x0000, CMP_DEVICE_TYPE_MOBILE_PHONE = 0x0001, CMP_DEVICE_TYPE_TABLET = 0x0002, CMP_DEVICE_TYPE_LAPTOP = 0x0003,
  CMP_DEVICE_TYPE_PC = 0x0004, CMP_DEVICE_TYPE_MAC = 0x0005
}
 Type of client device. More...
enum  CMP_PICKER_CONTROL_STATE { CMP_PICKER_CONTROL_STATE_VISIBLE = 0x0001, CMP_PICKER_CONTROL_STATE_SELECTED = 0x0002, CMP_PICKER_CONTROL_STATE_ABORTED = 0x0004, CMP_PICKER_CONTROL_STATE_BACKGROUND = 0x0008 }
 Picker control state flags. More...
enum  CMP_VIEWPORT_VALID_FLAGS { CMP_VIEWPORT_VALID_FLAG_ZOOM_FACTOR = 0x0001, CMP_VIEWPORT_VALID_FLAG_SERVER_VIEWPORT = 0x0002, CMP_VIEWPORT_VALID_FLAG_CLIENT_VIEWPORT = 0x0004 }
 Used to indicate which fields are valid for the functions. This allows for less information to be changed or retrieved. More...
enum  CMP_CAPTURE_QUALITY {
  CMP_CAPTURE_QUALITY_DEFAULT = 0, CMP_CAPTURE_QUALITY_05 = 5, CMP_CAPTURE_QUALITY_10 = 10, CMP_CAPTURE_QUALITY_15 = 15,
  CMP_CAPTURE_QUALITY_20 = 20, CMP_CAPTURE_QUALITY_LOW = 25, CMP_CAPTURE_QUALITY_30 = 30, CMP_CAPTURE_QUALITY_35 = 35,
  CMP_CAPTURE_QUALITY_40 = 40, CMP_CAPTURE_QUALITY_45 = 45, CMP_CAPTURE_QUALITY_MEDIUM = 50, CMP_CAPTURE_QUALITY_55 = 55,
  CMP_CAPTURE_QUALITY_60 = 60, CMP_CAPTURE_QUALITY_65 = 65, CMP_CAPTURE_QUALITY_70 = 70, CMP_CAPTURE_QUALITY_HIGH = 75,
  CMP_CAPTURE_QUALITY_80 = 80, CMP_CAPTURE_QUALITY_85 = 85, CMP_CAPTURE_QUALITY_90 = 90, CMP_CAPTURE_QUALITY_95 = 95,
  CMP_CAPTURE_QUALITY_MAXIMUM = 100
}
 The capture quality relates to level of quality for the picture, video, or audio clip. More...
enum  CMP_CAPTURE_CAMERA { CMP_CAPTURE_CAMERA_DEFAULT = 0x0000, CMP_CAPTURE_CAMERA_FRONT = 0x0001, CMP_CAPTURE_CAMERA_BACK = 0x0002 }
 Selects the camera to use with capture picture and video. More...
enum  CMP_AUDIO_ENCODING {
  CMP_AUDIO_ENCODING_DEFAULT = 0x0000, CMP_AUDIO_ENCODING_MPEG4 = 0x0001, CMP_AUDIO_ENCODING_MP3 = 0x0002, CMP_AUDIO_ENCODING_3GPP = 0x0003,
  CMP_AUDIO_ENCODING_WAV = 0x0004, CMP_AUDIO_ENCODING_AAC_ADTS = 0x0005, CMP_AUDIO_ENCODING_AMR_NB = 0x0006, CMP_AUDIO_ENCODING_AMR_WB = 0x0007
}
 Encoding technique used with audio. More...
enum  CMP_THUMBNAIL_TYPE {
  CMP_THUMBNAIL_NONE = 0x0000, CMP_THUMBNAIL_DEFAULT = 0x0001, CMP_THUMBNAIL_SMALL = 0x0002, CMP_THUMBNAIL_MEDIUM = 0x0003,
  CMP_THUMBNAIL_LARGE = 0x0004, CMP_THUMBNAIL_CUSTOM = 0x0005
}
 Type of thumbnail. Either this means no thumbnail or different sizes. More...
enum  CMP_VIDEO_ENCODING {
  CMP_VIDEO_ENCODING_DEFAULT = 0x0000, CMP_VIDEO_ENCODING_MPEG4 = 0x0001, CMP_VIDEO_ENCODING_H264 = 0x0002, CMP_VIDEO_ENCODING_H263 = 0x0003,
  CMP_VIDEO_ENCODING_3GPP = 0x0004
}
 Video encoding types. More...

Detailed Description

CMPAPI - Enumeration definitions for Citrix Mobility Pack.


Define Documentation

#define CMP_PICKER_CONTROL_ALL_FLAGS   0x0003

All picker control support flags.

#define CMP_VIEWPORT_VALID_FLAG_ALL   0x0007

Combination of all valid viewport flags.

#define IMAGE_FORMAT_SUPPORT_ALL   0x0003

Combination of all image formats.


Enumeration Type Documentation

Encoding technique used with audio.

Enumerator:
CMP_AUDIO_ENCODING_DEFAULT 

default audio encoding (defined by device)

CMP_AUDIO_ENCODING_MPEG4 

Moving Picture Experts Group

CMP_AUDIO_ENCODING_MP3 

Moving Picture Experts Group

CMP_AUDIO_ENCODING_3GPP 

3rd Generation Partnership Project

CMP_AUDIO_ENCODING_WAV 

Microsoft Wave

CMP_AUDIO_ENCODING_AAC_ADTS 

Advanced Audio Coding - Audio Data Transport Stream

CMP_AUDIO_ENCODING_AMR_NB 

Adaptive Multi Rate - Narrow Band

CMP_AUDIO_ENCODING_AMR_WB 

Adaptive Multi Rate - Wide Band

Button identification.

Enumerator:
CMP_BUTTON_BACK 

Back button.

CMP_BUTTON_SEARCH 

Search button.

CMP_BUTTON_HOME 

Home button.

CMP_BUTTON_MENU 

Menu button.

Destination for button events.

Enumerator:
CMP_BUTTON_TARGET_HOST 

Button events sent to server

CMP_BUTTON_TARGET_CLIENT 

Button events sent to mobile device

Selects the camera to use with capture picture and video.

Enumerator:
CMP_CAPTURE_CAMERA_DEFAULT 

Default camera selected (defined by device)

CMP_CAPTURE_CAMERA_FRONT 

Front camera (facing user)

CMP_CAPTURE_CAMERA_BACK 

Back camera (facing away from user)

The capture quality relates to level of quality for the picture, video, or audio clip.

Enumerator:
CMP_CAPTURE_QUALITY_DEFAULT 

Default quality which is defined by device

CMP_CAPTURE_QUALITY_05 

Five percent of full quality

CMP_CAPTURE_QUALITY_10 

Ten percent of full quality

CMP_CAPTURE_QUALITY_15 

Fifteen percent of full quality

CMP_CAPTURE_QUALITY_20 

Twenty percent of full quality

CMP_CAPTURE_QUALITY_LOW 

Twenty five percent of full quality

CMP_CAPTURE_QUALITY_30 

Thirty percent of full quality

CMP_CAPTURE_QUALITY_35 

Thirty five percent of full quality

CMP_CAPTURE_QUALITY_40 

Forty percent of full quality

CMP_CAPTURE_QUALITY_45 

Forty five percent of full quality

CMP_CAPTURE_QUALITY_MEDIUM 

Fifty percent of full quality

CMP_CAPTURE_QUALITY_55 

Fifty five percent of full quality

CMP_CAPTURE_QUALITY_60 

Sixty percent of full quality

CMP_CAPTURE_QUALITY_65 

Sixty five percent of full quality

CMP_CAPTURE_QUALITY_70 

Seventy percent of full quality

CMP_CAPTURE_QUALITY_HIGH 

Seventy five percent of full quality

CMP_CAPTURE_QUALITY_80 

Eighty percent of full quality

CMP_CAPTURE_QUALITY_85 

Eighty five percent of full quality

CMP_CAPTURE_QUALITY_90 

Ninety percent of full quality

CMP_CAPTURE_QUALITY_95 

Ninety five percent of full quality

CMP_CAPTURE_QUALITY_MAXIMUM 

Full quality

State of the channel.

Enumerator:
CMP_CHANNEL_STATE_INITIAL 

Initial state

CMP_CHANNEL_STATE_CONNECTED 

Connected

CMP_CHANNEL_STATE_DISCONNECTED 

Disconnected

CMP_CHANNEL_STATE_BOUND 

Channel is bound

CMP_CHANNEL_STATE_BIND_FAILURE 

Channel bind has failed

Component Ids used with error codes.

Enumerator:
COMPONENT_COMMON 

Common component (non-specific)

COMPONENT_BUTTON 

Button component

COMPONENT_CAMERA 

Camera component

COMPONENT_RECEIVER 

Receiver component

COMPONENT_DEVICE 

Device component

COMPONENT_DISPLAY 

Display component

COMPONENT_KEYBOARD 

Keyboard component

COMPONENT_MESSAGE 

Message component

COMPONENT_PHONE 

Phone component

COMPONENT_PICKER 

Picker component

COMPONENT_EVENT 

Event component

COMPONENT_CHANNEL 

Channel component

COMPONENT_NOTIFY 

Notify component

COMPONENT_SESSION 

Session component

COMPONENT_CAPS 

Capability component

COMPONENT_CONTROLS 

Controls component

COMPONENT_GVCH 

GVCH component

COMPONENT_VDO 

Virtual Device Object component

COMPONENT_CAPTURE 

Capture (Picture, Video, and Audio) component

COMPONENT_EMULATOR 

Emulator component

device boolean property definitions.

Enumerator:
CMP_DEVICE_BOOL_PROP_ID_FIRST 
CMP_DEVICE_3G 

Supports 3G network

CMP_DEVICE_4G 

Supports 4G network

CMP_DEVICE_ACCELEROMETER 

Supports accelerometer

CMP_DEVICE_AUDIO_OUTPUT 

Audio output

CMP_DEVICE_BATTERY 

Battery present

CMP_DEVICE_BLUETOOTH 

Bluetooth support

CMP_DEVICE_CAMERA 

Camera

CMP_DEVICE_CAMERA_BACK 

Camera on back

CMP_DEVICE_CAMERA_FRONT 

Camera in front

CMP_DEVICE_COMPASS 

Compass

CMP_DEVICE_COMPONENT_VIDEO 

Component video out

CMP_DEVICE_COMPOSITE_VIDEO 

Composite video out

CMP_DEVICE_GSM 

Supports GSM network

CMP_DEVICE_GPS 

GPS

CMP_DEVICE_GYROSCOPE 

Gyroscope

CMP_DEVICE_HDMI_VIDEO 

HDMI out

CMP_DEVICE_MICRO_SD_CARD 

Micro SD card

CMP_DEVICE_MICROPHONE 

Microphone

CMP_DEVICE_MMS 

MMS

CMP_DEVICE_MOUSE 

Mouse

CMP_DEVICE_MULTI_TOUCH 

Multi-touch

CMP_DEVICE_ORIENTATION_CHANGES 

Orientation

CMP_DEVICE_PHYSICAL_KEYBOARD 

Physical keyboard

CMP_DEVICE_SENSOR_LIGHT 

Sensor light

CMP_DEVICE_SIM 

SIM present

CMP_DEVICE_SMS 

SMS

CMP_DEVICE_TOUCH_SCREEN 

Touch screen

CMP_DEVICE_TRACKBALL 

Trackball

CMP_DEVICE_WIFI 

WiFi

CMP_DEVICE_WIRELESS_PHONE 

Wireless phone

CMP_DEVICE_BOOL_PROP_ID_LAST 

device string property definitions.

Enumerator:
CMP_DEVICE_STRING_PROP_ID_FIRST 
CMP_DEVICE_MANUFACTURER 

Mobile device manufacturer name

CMP_DEVICE_MODEL 

Mobile device model

CMP_DEVICE_SERIAL_NUMBER 

Mobile device serial number

CMP_DEVICE_GIVEN_NAME 

Given device name

CMP_DEVICE_WIFI_MAC_ADDRESS 

WiFi network MAC address

CMP_DEVICE_BLUETOOTH_MAC_ADDRESS 

Bluetooth network MAC address

CMP_DEVICE_STRING_PROP_ID_LAST 

Device operating system identifiers.

Enumerator:
CMP_DEVICE_OS_UNKNOWN 

Unknown operating system

CMP_DEVICE_OS_ANDROID 

Android

CMP_DEVICE_OS_IOS 

Apple iOS

CMP_DEVICE_OS_BLACKBERRY 

Blackberry

CMP_DEVICE_OS_WINDOWS_MOBILE 

Windows Mobile

CMP_DEVICE_OS_WINDOWS_PHONE 

Windows Phone

CMP_DEVICE_OS_WEBOS 

WebOS

CMP_DEVICE_OS_QNX 

Qnx

CMP_DEVICE_OS_BADA 

Bada

CMP_DEVICE_OS_MEEGO 

Meego

CMP_DEVICE_OS_WINDOWS 

Windows

CMP_DEVICE_OS_OSX 

Apple OSX

CMP_DEVICE_OS_LINUX 

Linux

Type of client device.

Enumerator:
CMP_DEVICE_TYPE_UNKNOWN 

Unknown device type

CMP_DEVICE_TYPE_MOBILE_PHONE 

Mobile phone

CMP_DEVICE_TYPE_TABLET 

Mobile tablet

CMP_DEVICE_TYPE_LAPTOP 

Laptop

CMP_DEVICE_TYPE_PC 

PC

CMP_DEVICE_TYPE_MAC 

MAC

CMPRESULT error definitions.

CMP_ERROR_ID is INT32 and the basis for CMPRESULT. The encoding of CMP_ERROR_ID is based on two pieces. It contains the component Id in the top 16-bit of the INT32 and the return code in the lower INT32. If the lower part (WORD) is zero, the operation was successful. This allows for different components to return success with the component code intact. However, it also means that checking the INT32 value against zero is invalid since it will report an error for non zero component ids.

It is safer to use CMP_SUCCESS and CMP_FAILURE macros to determine success or failure.

Enumerator:
CMP_NO_ERROR 

(0x00000000) No error

CMP_ERROR_INVALID_FUNCTION 

(0x00000001) Invalid Function

CMP_ERROR_NOT_FOUND 

(0x00000002) Not found

CMP_ERROR_NOT_SUPPORTED 

(0x00000003) Not supported

CMP_ERROR_INVALID_PARAMETER 

(0x00000004) Invalid parameter

CMP_ERROR_NULL_PARAMETER 

(0x00000005) Null parameter

CMP_ERROR_COM_INITIALIZE 

(0x00000006) COM did not initialize

CMP_ERROR_COM_CREATE_INSTANCE 

(0x00000007) COM instance not created

CMP_ERROR_CONVERTING_UTF8 

(0x00000008) Error converting UTF-8 string

CMP_ERROR_CONVERTING_UTF16_TO_UTF8 

(0x00000009) Error converting UTF-16 to UTF-8

CMP_ERROR_MISSING_INTERFACE 

(0x0000000A) Missing COM interface

CMP_ERROR_INVALID_SIZE 

(0x0000000B) Invalid size

CMP_ERROR_ACCESS_DENIED 

(0x0000000C) Access Denied

CMP_ERROR_REGISTERING_INTERFACES 

(0x0000000D) Error registering interfaces

CMP_ERROR_TIMEOUT 

(0x0000000E) Timeout error

CMP_ERROR_UTF8_TO_UTF16_LENGTH 

(0x0000000F) Error with UTF-8 to UTF-16 length

CMP_ERROR_UTF16_TO_UTF8_LENGTH 

(0x00000010) Error with UTF-16 to UTF-8 length

CMP_ERROR_BUFFER_TOO_SMALL 

(0x00000011) Buffer too small

CMP_ERROR_NOT_ENOUGH_MEMORY 

(0x00000012) Not enough memory

CMP_ERROR_NOT_FOREGROUND_WINDOW 

(0x00000013) Not foreground window

CMP_ERROR_SESSION_NOT_FOUND 

(0x00000014) Session not found

CMP_ERROR_SYSTEM_HOOK_FAILED 

(0x00000015) Windows system hook failed

CMP_ERROR_NOT_CONNECTED 

(0x00000016) Not connected

CMP_ERROR_INVALID_HANDLE 

(0x00000017) Invalid Handle

CMP_ERROR_GETTING_SAFEARRAY_ELEMENT 

(0x00000018) Error getting safearray element

CMP_ERROR_BUFFER_OVERFLOW 

(0x00000019) Buffer overflow

CMP_ERROR_PACKET_FIELD 

(0x0000001A) Error with packet field

CMP_ERROR_UNRECOGNIZED_STORAGE_PATH 

(0x0000001B) Unrecognized storage path

CMP_ERROR_PACKET_TOO_SMALL 

(0x0000001C) Packet too small

CMP_ERROR_GETTING_API_VERSION 

(0x0000001D) Error getting API version

CMP_ERROR_CREATING_OBJECT 

(0x0000001E) Error creating object

CMP_ERROR_INVALID_PACKET_FIELD_OFFSET 

(0x0000001F) Invalid packet field offset

CMP_ERROR_INVALID_PACKET_FIELD_LENGTH 

(0x00000020) Invalid packet field length

CMP_ERROR_PACKET_TOO_BIG 

(0x00000021) Packet too big

CMP_ERROR_FILE_NOT_FOUND 

(0x00000022) File not found

CMP_ERROR_INTERNAL_ERROR 

(0x00000023) Internal error

CMP_ERROR_SERVICE_DOES_NOT_EXIST 

(0x00000024) Service does not exist

CMP_ERROR_GET_FILE_PATH 

(0x00000025) Error getting file path

CMP_ERROR_BIND_RESPONSE_PACKET 

(0x00000026) Error with bind response packet

CMP_ERROR_PICKER_SHOW_PACKET 

(0x00000027) Error with picker show packet

CMP_ERROR_INVALID_PROCESS_ID 

(0x00000028) Invalid process Id

CMP_ERROR_INSUFFICIENT_BUFFER 

(0x00000029) Insufficient buffer

CMP_ERROR_INVALID_FLAGS 

(0x0000002A) Invalid flags

CMP_ERROR_NO_UNICODE_TRANSLATION 

(0x0000002B) No Unicode translation

CMP_ERROR_CLIENT_DRIVE_UNAVAILABLE 

(0x0000002C) Client drive unavailable

CMP_ERROR_SD_CARD_UNMOUNTED 

(0x0000002D) SD card unmounted

CMP_ERROR_NETWORK_ENUMERATE 

(0x0000002E) Error with network enumerate

CMP_ERROR_NOT_CONTAINER 

(0x0000002F) Not network container

CMP_ERROR_NO_NETWORK 

(0x00000030) No network

CMP_ERROR_INVALID_ADDRESS 

(0x00000031) Invalid address

CMP_ERROR_NO_MORE_ITEMS 

(0x00000032) No more items

CMP_ERROR_MORE_DATA 

(0x00000033) More data available

CMP_ERROR_LOADING_DLL 

(0x00000034) Could not load DLL

CMP_ERROR_INTERFACE_NOT_AVAILABLE 

(0x00000035) CMP Interface not available

CMP_ERROR_GENERATING_HASH_VALUE 

(0x00000036) Could not generate hash value

CMP_ERROR_GENERATING_RANDOM_DATA 

(0x00000037) Could not generate random data

CMP_ERROR_CREATING_INTERNAL_CLASS 

(0x00000038) Could not create internal windows class

CMP_ERROR_CREATING_INTERNAL_WINDOW 

(0x00000039) Could not create internal window

CMP_ERROR_CREATING_THREAD 

(0x0000003A) Error creating thread

CMP_ERROR_CLASS_ALREADY_EXISTS 

(0x0000003B) Window class already exists

CMP_ERROR_PREVIOUS_REQUEST_PENDING 

(0x0000003C) A request is already pending

CMP_BUTTON_NO_ERROR 

(0x00010000) No error

CMP_ERROR_UNSUPPORTED_BUTTON_ID 

(0x00010001) Button Id not supported

CMP_ERROR_SET_BUTTON_TARGET 

(0x00010002) Error SetButtonTarget

CMP_ERROR_GET_BUTTON_TARGET 

(0x00010003) Error GetButtonTarget

CMP_ERROR_GET_BUTTON_TARGET_TIMEOUT 

(0x00010004) Error GetButtonTarget timeout

CMP_CAMERA_NO_ERROR 

(0x00020000) No error

CMP_ERROR_TAKE_PICTURE 

(0x00020001) Error with TakePicture

CMP_ERROR_NO_CAMERA 

(0x00020002) No camera

CMP_ERROR_UNSUPPORTED_IMAGE_FORMAT 

(0x00020003) Unsupported image format

CMP_ERROR_GET_PICTURE_FILENAME 

(0x00020004) Error GetPictureFilename

CMP_ERROR_GET_PICTURE_FILENAME_TIMEOUT 

(0x00020005) Timeout GetPictureFilename

CMP_ERROR_CANCEL_TAKE_PICTURE 

(0x00020006) User cancelled taking a picture

CMP_ERROR_REMOVE_PICTURE 

(0x00020007) Error RemovePicture

CMP_ERROR_GET_PICTURE_STATE_TIMEOUT 

(0x00020008) Timeout GetPictureState

CMP_ERROR_GET_PICTURE_STATE 

(0x00020009) Error GetPictureState

CMP_ERROR_ALREADY_TAKING_PICTURE 

(0x0002000A) Picture is already being taken.

CMP_DEVICE_NO_ERROR 

(0x00040000) No error

CMP_ERROR_INVALID_PROP_ID 

(0x00040001) Invalid property Id

CMP_ERROR_INVALID_PROPERTY_TYPE 

(0x00040002) Invalid property type

CMP_ERROR_GET_DEVICE_STRING 

(0x00040003) Error GetDeviceString

CMP_ERROR_GET_DEVICE_STRING_TIMEOUT 

(0x00040004) Error GetDeviceString timeout

CMP_ERROR_GET_DEVICE_BOOL 

(0x00040005) Error GetDeviceBool

CMP_ERROR_GET_DEVICE_BOOL_TIMEOUT 

(0x00040006) Error GetDeviceBool timeout

CMP_ERROR_UNSUPPORTED_PROP_ID 

(0x00040007) Unsupported property Id

CMP_DISPLAY_NO_ERROR 

(0x00050000) No error

CMP_ERROR_SET_SCROLL_MODE 

(0x00050001) Error with SetScrollMode

CMP_ERROR_SET_ORIENTATION 

(0x00050002) Error with SetOrientation

CMP_ERROR_GET_ORIENTATION 

(0x00050003) Error with GetOrientation

CMP_ERROR_SET_VIEWPORT_ORIGIN 

(0x00050004) Error with SetViewportOrigin

CMP_ERROR_GET_ORIENTATION_TIMEOUT 

(0x00050005) Timeout with GetOrientation

CMP_ERROR_GET_SCROLL_MODE 

(0x00050006) Error with GetScrollMode

CMP_ERROR_GET_SCROLL_MODE_TIMEOUT 

(0x00050007) Timeout with GetScrollMode

CMP_ERROR_GET_VIEWPORT_ORIGIN 

(0x00050008) Error with GetViewportOrigin

CMP_ERROR_GET_VIEWPORT_ORIGIN_TIMEOUT 

(0x00050009) Timeout with GetViewportOrigin

CMP_ERROR_GET_DISPLAY_SETTINGS 

(0x0005000A) Error with GetDisplaySettings

CMP_ERROR_GET_DISPLAY_SETTINGS_TIMEOUT 

(0x0005000B) Timeout with GetDisplaySettings

CMP_ERROR_GET_VIEWPORT 

(0x0005000C) Error with GetViewport

CMP_ERROR_GET_VIEWPORT_TIMEOUT 

(0x0005000D) Timeout with GetViewport

CMP_ERROR_SET_VIEWPORT 

(0x0005000E) Error with SetViewport

CMP_ERROR_SET_ORIENTATION_SUPPORTED 

(0x0005000F) Error with SetOrientationSupported

CMP_ERROR_GET_ORIENTATION_SUPPORTED 

(0x00050010) Error with GetOrientationSupported

CMP_ERROR_GET_ORIENTATION_SUPPORTED_TIMEOUT 

(0x00050011) Error GetOrientationSupported timeout

CMP_ERROR_VIEWPORT_ORIGIN_LOCKED 

(0x00050012) The viewport origin is locked and cannot be changed due to DRAG scroll mode

CMP_ERROR_VIEWPORT_LOCKED 

(0x00050013) The viewport is locked and cannot be changed due to DRAG scroll mode

CMP_KEYBOARD_NO_ERROR 

(0x00070000) No error

CMP_ERROR_SHOWING_KEYBOARD 

(0x00070001) Error showing keyboard

CMP_ERROR_HIDING_KEYBOARD 

(0x00070002) Error hiding keyboard

CMP_ERROR_GET_KEYBOARD_STATE 

(0x00070003) Error GetKeyboardState

CMP_ERROR_GET_KEYBOARD_STATE_TIMEOUT 

(0x00070004) Error GetKeyboardState timeout

CMP_SMS_NO_ERROR 

(0x00080000) No error

CMP_ERROR_SEND_SMS 

(0x00080001) Error with SendSMS

CMP_ERROR_ALREADY_SENDING_SMS 

(0x00080002) SMS app is already sending sms

CMP_PHONE_NO_ERROR 

(0x00090000) No error

CMP_ERROR_START_PHONE_CALL 

(0x00090001) Error with StartPhoneCall

CMP_ERROR_INVALID_PHONE_NUMBER 

(0x00090002) Invalid phone number

CMP_ERROR_PHONE_NUMBER_TOO_LONG 

(0x00090003) Phone number too long

CMP_ERROR_ALREADY_STARTING_CALL 

(0x00090004) Phone app is already making a call

CMP_PICKER_NO_ERROR 

(0x000A0000) No error

CMP_ERROR_SHOW_PICKER_CONTROL 

(0x000A0001) Error ShowPicker

CMP_ERROR_HIDE_PICKER_CONTROL 

(0x000A0002) Error HidePicker

CMP_ERROR_GET_PICKER_STATE 

(0x000A0003) Error GetPickerState

CMP_ERROR_GET_PICKER_STATE_TIMEOUT 

(0x000A0004) Timeout GetPickerState

CMP_ERROR_PICKER_TITLE_TOO_LONG 

(0x000A0005) Picker title too long

CMP_ERROR_PICKER_LIST_TOO_BIG 

(0x000A0006) Picker list too long

CMP_EVENT_NO_ERROR 

(0x000C0000) No error

CMP_ERROR_EVENT_UNKNOWN_EVENT_ID 

(0x000C0001) Unknown event Id

CMP_ERROR_EVENT_HOOKING_FAILURE 

(0x000C0002) Error hooking event

CMP_CHANNEL_NO_ERROR 

(0x000D0000) No error

CMP_ERROR_OPEN_CHANNEL 

(0x000D0001) Error opening channel

CMP_ERROR_BIND_FAILED 

(0x000D0002) Bind failed

CMP_ERROR_NOT_BOUND 

(0x000D0003) Not bound

CMP_ERROR_UNBIND_FAILED 

(0x000D0005) Unbind failed

CMP_ERROR_BIND_TIMEOUT 

(0x000D0006) Bind timeout

CMP_NOTIFY_NO_ERROR 

(0x000E0000) No error

CMP_ERROR_NOTIFY_TEXT_TOO_LONG 

(0x000E0001) Notify text too long

CMP_ERROR_NOTIFY_USER 

(0x000E0002) Error with NotifyUser

CMP_SESSION_NO_ERROR 

(0x000F0000) No error

CMP_ERROR_NO_SESSION 

(0x000F0001) No session

CMP_ERROR_SESSION_ALREADY_OPEN 

(0x000F0002) Session already open

CMP_ERROR_CREATING_SESSION 

(0x000F0003) Error creating session

CMP_ERROR_SESSION_OPTION_INVALID 

(0x000F0004) Session option invalid

CMP_ERROR_REGISTER_CMP_PROCESS 

(0x000F0005) Error register process

CMP_ERROR_UNREGISTER_CMP_PROCESS 

(0x000F0006) Error unregister process

CMP_CAPABILITIES_NO_ERROR 

(0x00100000) Capabilities no error

CMP_ERROR_CAPABILITY_NOT_SUPPORTED 

(0x00100001) Capability not supported

CMP_ERROR_NO_CAPABILITIES 

(0x00100002) No capabilities

CMP_ERROR_CAPABILITY_VALUE_NOT_FOUND 

(0x00100003) Capability value not found

CMP_ERROR_CAPABILITY_NOT_FOUND 

(0x00100004) Capability not found

CMP_ERROR_CAPABILITY_TYPE_MISMATCH 

(0x00100005) Capability type mismatch

CMP_ERROR_CAPABILITY_SIZE_MISMATCH 

(0x00100006) Capability size mismatch

CMP_ERROR_CAPABILITY_INVALID_VALUE_TYPE 

(0x00100007) Invalid capability value type

CMP_ERROR_CAPABILITY_VALUE_OVERFLOW 

(0x00100008) Capability value overflow

CMP_CONTROLS_NO_ERROR 

(0x00110000) No error

CMP_ERROR_ENABLE_OR_DISABLE_CONTROLS 

(0x00110001) Error enabling/disabling control

CMP_ERROR_GET_CONTROLS_FLAGS_TIMEOUT 

(0x00110002) Error get controlsflags timeout

CMP_ERROR_GET_CONTROLS_FLAGS 

(0x00110003) Error getting controlsflags

CMP_GVCH_NO_ERROR 

(0x00120000) No error

CMP_ERROR_GVCH_IO_DATA_OUT_OF_BOUNDS 

(0x00120001) Out of bounds

CMP_ERROR_GVCH_IO_DATA_STRING_TOO_BIG 

(0x00120002) String too big

CMP_ERROR_GVCH_IO_DATA_STRING_INVALID 

(0x00120003) String invalid

CMP_ERROR_GVCH_IO_DATA_DATA_TOO_BIG 

(0x00120004) Too big

CMP_ERROR_GVCH_IO_DATA_HEADER_TOO_SMALL 

(0x00120005) Header too small

CMP_ERROR_GVCH_INVALID_STATE_FOR_CALL 

(0x00120006) Invalid state

CMP_ERROR_GVCH_INVALID_VC_NAME 

(0x00120007) Invalid virtual channel name

CMP_ERROR_GVCH_NOT_CONNECTED_STATE 

(0x00120008) Not connected

CMP_ERROR_GVCH_INVALID_SESSION 

(0x00120009) Invalid session

CMP_ERROR_GVCH_INVALID_VC_MGR 

(0x0012000A) Invalid virtual channel manager

CMP_VDO_NO_ERROR 

(0x00130000) No error

CMP_ERROR_VDO_CONTEXT_SET 

(0x00130001) Error setting the context for a process

CMP_ERROR_VDO_CONTEXT_ACTIVATE 

(0x00130002) Error activating the context for a process

CMP_CAPTURE_NO_ERROR 

(0x00140000) No error

CMP_ERROR_CAPTURE_PICTURE 

(0x00140001) Error capturing picture

CMP_ERROR_CAPTURE_VIDEO 

(0x00140002) Error capturing video

CMP_ERROR_CAPTURE_AUDIO 

(0x00140003) Error capturing audio

CMP_ERROR_CAPTURE_OPTIONS_TOO_LONG 

(0x00140004) Error capture text is too long

CMP_ERROR_CAPTURE_REMOVE 

(0x00140005) Error unable to remove captured data

CMP_ERROR_CAPTURE_CANCEL 

(0x00140006) User cancelled the capture operation

CMP_ERROR_AUDIO_RECORDING_DISABLED 

(0x00140007) Audio recording has been disabled in the receiver settings

CMP_ERROR_ALREADY_CAPTURING 

(0x00140008) Capture request is already being processed

CMP_ERROR_EMULATOR_SIMULATED_FAILURE 

(0x00150001) Emulator failed because API success was disabled.

CMP_ERROR_EMULATOR_PIPE_NOT_FOUND 

(0x00150002) Failed to connect to emulator.

CMP_ERROR_EMULATOR_PIPE_BROKEN 

(0x00150003) Pipe disconnect or failure.

CMP_ERROR_EMULATOR_AUTO_LAUNCH 

(0x00150004) Unable to launch emulator.

Examples:
csharp/captureaudio/Program.cs, csharp/capturepicture/Program.cs, csharp/capturevideo/Program.cs, csharp/takepicture/Program.cs, winform/captureaudio/Form1.cs, winform/capturepicture/Form1.cs, and winform/capturevideo/Form1.cs.

Event identifiers.

Enumerator:
CMP_EVENT_APP_FOREGROUND 

AppForeground

CMP_EVENT_APP_BACKGROUND 

AppBackground

CMP_EVENT_FOREGROUND_APP_CHANGED 

ForegroundAppChanged

CMP_EVENT_BUTTON_PRESSED 

ButtonPressed

CMP_EVENT_DISPLAY_SETTINGS_CHANGED 

DisplaySettingsChanged

CMP_EVENT_ORIENTATION_CHANGED 

OrientationChanged

CMP_EVENT_SCROLL_MODE_CHANGED 

ScrollModeChanged

CMP_EVENT_KEYBOARD_STATE_CHANGED 

KeyboardStateChanged

CMP_EVENT_VIEWPORT_CHANGED 

ViewportChanged

CMP_EVENT_VIEWPORT_ORIGIN_CHANGED 

ViewportOriginChanged

CMP_EVENT_BUTTON_TARGET_CHANGED 

ButtonTargetChanged

CMP_EVENT_CONTROL_STATE_CHANGED 

ControlStateChanged

CMP_EVENT_SMS_STARTED 

SMSStarted

CMP_EVENT_PHONE_CALL_STARTED 

PhoneCallStarted

CMP_EVENT_PICKER_CONTROL_STATE_CHANGED 

PickerControlStateChanged

CMP_EVENT_CAMERA_PICTURE_TAKEN 

PictureTaken

CMP_EVENT_FILTER_CHANGED 

FilterChanged

CMP_EVENT_USER_NOTIFIED 

UserNotified

CMP_EVENT_CAMERA_PICTURE_REMOVED 

PictureRemoved

CMP_EVENT_SESSION_STATE_CHANGED 

SessionStateChanged

CMP_EVENT_CHANNEL_STATE_CHANGED 

ChannelStateChanged

CMP_EVENT_PICTURE_CAPTURED 

PictureCaptured

CMP_EVENT_VIDEO_CAPTURED 

VideoCaptured

CMP_EVENT_AUDIO_CAPTURED 

AudioCaptured

CMP_EVENT_SUPPORTED_ORIENTATIONS_CHANGED 

SupportedOrientationsChanged

CMP_EVENT_CAPTURE_MEDIA_REMOVED 

CaptureMediaRemoved

CMP_EVENT_ALL 

All events

Image formats for Take Picture.

Enumerator:
CMP_IMAGE_FORMAT_JPEG 

JPEG format

CMP_IMAGE_FORMAT_PNG 

PNG format

Examples:
native/takepicture/takepicture.cpp.

Image formats supported by CMP.

Enumerator:
CMP_IMAGE_FORMAT_JPEG_SUPPORT 

JPEG support

CMP_IMAGE_FORMAT_PNG_SUPPORT 

PNG support

Auto capitalization options for keyboard.

Enumerator:
CMP_KYBD_AUTO_CAPITAL_NONE 

Do not auto capitalize text.

CMP_KYBD_AUTO_CAPITAL_WORDS 

Auto-capitalize all words.

CMP_KYBD_AUTO_CAPITAL_SENTENCES 

Auto-capitalize all sentences.

CMP_KYBD_AUTO_CAPITAL_LETTERS 

Auto-capitalize all letters.

Keyboard flag options.

Enumerator:
CMP_KYBD_FLAG_PHYSICAL 

Physical keyboard available (get but not set).

CMP_KYBD_FLAG_VISIBLE 

Display keyboard visible (get but not set).

CMP_KYBD_FLAG_EXT_FLAG 

Extended keyboard.

CMP_KYBD_FLAG_USE_RECT 

Use rectangle co-ordinates for viewing section of display.

CMP_KYBD_FLAG_AUTO_CORRECT 

Auto correct text.

CMP_KYBD_FLAG_AUTO_CAPITAL 

Auto-capitalize text.

CMP_KYBD_FLAG_RETURN_KEY_TYPE 

Return key text to show.

Types of return key text for keyboard.

Enumerator:
CMP_KYBD_RETURN_KEY_DEFAULT 

Return key = default value.

CMP_KYBD_RETURN_KEY_GO 

Return key = Go.

CMP_KYBD_RETURN_KEY_GOOGLE 

Return key = Google.

CMP_KYBD_RETURN_KEY_JOIN 

Return key = Join.

CMP_KYBD_RETURN_KEY_NEXT 

Return key = Next.

CMP_KYBD_RETURN_KEY_ROUTE 

Return key = Route.

CMP_KYBD_RETURN_KEY_SEARCH 

Return key = Search.

CMP_KYBD_RETURN_KEY_SEND 

Return key = Send.

CMP_KYBD_RETURN_KEY_DONE 

Return key = Done.

Type of keyboards which can be selected.

Enumerator:
CMP_KYBD_TYPE_UNKNOWN 

Unknown keyboard type

CMP_KYBD_TYPE_PHYSICAL 

Physical keyboard

CMP_KYBD_TYPE_STANDARD 

Standard keyboard

CMP_KYBD_TYPE_NUMBER_PAD 

Numeric keypad

CMP_KYBD_TYPE_PHONE_PAD 

Phone keypad

CMP_KYBD_TYPE_URL 

URL keyboard

CMP_KYBD_TYPE_EMAIL 

Email keyboard

CMP_KYBD_TYPE_PHONE_NAME 

Phone name keyboard

CMP_KYBD_TYPE_NUMBERS_PUNC 

Numbers and punctuation keyboard

CMP_KYBD_TYPE_DECIMAL_POINT 

Numeric keypad with decimal point

Notification option flags.

Enumerator:
CMP_NOTIFICATION_FLAG_LIGHT 

Light notification

CMP_NOTIFICATION_FLAG_VIBRATE 

Vibrate

CMP_NOTIFICATION_FLAG_AUDIO 

Audio

CMP_NOTIFICATION_FLAG_TEXT 

Text

CMP_NOTIFICATION_ALL_FLAGS 

All notification flags

Orientation flags.

Enumerator:
CMP_ORIENTATION_FLAG_LOCK 

Lock the orientation in the specified position

CMP_ORIENTATION_FLAG_FOLLOW_SENSOR 

Keep the application orientation the same as the device

Orientation positions for mobile device.

Enumerator:
CMP_ORIENTATION_UNKNOWN 

Unknown orientation

CMP_ORIENTATION_PORTRAIT 

Portrait. Origin 0 degrees. Tall & narrow. Button(s) at bottom.

CMP_ORIENTATION_PORTRAIT_UPSIDE_DOWN 

Portrait. Flip 180 degrees. Tall & narrow. Button(s) at top.

CMP_ORIENTATION_LANDSCAPE_LEFT 

Landscape. Left 90 degrees. Wide & short. Button(s) at right.

CMP_ORIENTATION_LANDSCAPE_RIGHT 

Landscape. Right 90 degrees. Wide & short. Button(s) at left.

Examples:
csharp/orientation/Program.cs, native/orientation/orientation.cpp, winform/displaysettings/FormDisplaySettings.cs, and winform/displaysettings/FormOrientation.cs.

Picker control state flags.

Enumerator:
CMP_PICKER_CONTROL_STATE_VISIBLE 

Picker control is visible and not selected yet

CMP_PICKER_CONTROL_STATE_SELECTED 

Picker has been selected and index is valid

CMP_PICKER_CONTROL_STATE_ABORTED 

Picker control has been aborted

CMP_PICKER_CONTROL_STATE_BACKGROUND 

Picker control is currently waiting for app to be in foreground

Examples:
csharp/showpicker/Program.cs.

Picker control feature flags.

Enumerator:
CMP_PICKER_CONTROL_FLAG_SUPPORT 

Supports basic picker control operation.

CMP_PICKER_CONTROL_FLAG_TITLE_SUPPORT 

Supports adding a title to the picker control.

state of the specified picture.

Enumerator:
CMP_PICTURE_STATE_UNAVAILABLE 

Picture not available

CMP_PICTURE_STATE_READY 

Ready for retrieval

Scroll mode options.

Enumerator:
CMP_SCROLLMODE_MOUSEWHEEL 

Simulate touch as mousewheel.

CMP_SCROLLMODE_DRAG 

Simulate touch as drag.

CMP_SCROLLMODE_PAN 

Simulate touch as pan.

Option identifiers for changing values for session.

Enumerator:
CMP_SESSION_OPTION_IGNORE_FOREGROUND_CHECK 

Allow background apps to affect foreground apps

CMP_SESSION_OPTION_DISABLE_CACHE 

Disable the caching of CMP data

State of the session.

Enumerator:
CMP_SESSION_STATE_INITIAL 

Initial state

CMP_SESSION_STATE_CONNECTED 

Connected

CMP_SESSION_STATE_DISCONNECTED 

Disconnected

CMP_SESSION_STATE_LOCKED 

Locked

CMP_SESSION_STATE_UNLOCKED 

Unlocked

CMP_SESSION_STATE_LOGGED_ON 

LoggedOn

CMP_SESSION_STATE_LOGGED_OFF 

LoggedOff

CMP_SESSION_STATE_CONSOLE 

Console

Application can select which orientations it will support.

Instead of using a bitmask, this enumeration makes it easy to pick what the application can support. If the listed selection is not here, the correct one can be derived from combining the bits from individual orientation values.

Enumerator:
CMP_SO_ALL 

Application supports all orientations

CMP_SO_LANDSCAPE 

Application only supports landscape orientations

CMP_SO_PORTRAIT 

Application only supports portrait orientation

CMP_SO_LANDSCAPE_LEFT 

Application only supports landscape left

CMP_SO_LANDSCAPE_RIGHT 

Application only supports landscape right

CMP_SO_PORTRAIT_UP 

Application only supports portrait up

CMP_SO_PORTRAIT_DOWN 

Application only supports portrait down

CMP_SO_NO_PORTRAIT_DOWN 

Application supports everything but portrait down

Type of thumbnail. Either this means no thumbnail or different sizes.

Enumerator:
CMP_THUMBNAIL_NONE 

No thumbnail

CMP_THUMBNAIL_DEFAULT 

Default type (defined by device)

CMP_THUMBNAIL_SMALL 

Small thumbnail ~100x100

CMP_THUMBNAIL_MEDIUM 

Medium thumbnail ~300x300

CMP_THUMBNAIL_LARGE 

Large thumbnail ~600x600

CMP_THUMBNAIL_CUSTOM 

Custom size specified by parameters

Video encoding types.

Enumerator:
CMP_VIDEO_ENCODING_DEFAULT 

default video encoding (defined by device)

CMP_VIDEO_ENCODING_MPEG4 

Moving Picture Experts Group

CMP_VIDEO_ENCODING_H264 

H.264

CMP_VIDEO_ENCODING_H263 

H.263

CMP_VIDEO_ENCODING_3GPP 

3GPP

Used to indicate which fields are valid for the functions. This allows for less information to be changed or retrieved.

Enumerator:
CMP_VIEWPORT_VALID_FLAG_ZOOM_FACTOR 

Zoom factor is valid

CMP_VIEWPORT_VALID_FLAG_SERVER_VIEWPORT 

Server viewport is valid

CMP_VIEWPORT_VALID_FLAG_CLIENT_VIEWPORT 

Client viewport is valid

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Events Defines