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

#include <Session.h>

Inherited by CitrixMobile.

List of all members.

Public Member Functions

STDMETHODIMP IsSessionActive ([out, retval]VARIANT_BOOL *sessionActive)
 Determine if there is an active session object which is available.
STDMETHODIMP GetSessionState ([out, retval]CMP_SESSION_STATE *sessionState)
 Get the current state of the session.
STDMETHODIMP OpenSession ([out, retval]CMPRESULT *result)
 Open a session between the application and the mobile device.
STDMETHODIMP CloseSession ([out, retval]CMPRESULT *result)
 Close the session between the application and the mobile device.
STDMETHODIMP SetSessionOptionBool ([in]CMP_SESSION_OPTION option,[in]VARIANT_BOOL value,[out, retval]CMPRESULT *result)
 Set session boolean option.
STDMETHODIMP GetSessionOptionBool ([in]CMP_SESSION_OPTION option,[out]VARIANT_BOOL *value,[out, retval]CMPRESULT *result)
 Get session boolean option.
STDMETHODIMP GetErrorText ([in]CMP_ERROR_ID ErrorId,[out]BSTR *ErrorText,[out, retval]CMPRESULT *result)
 Retrieve text for error code - not implemented.
STDMETHODIMP RegisterCMPProcess ([in]DWORD processId,[out, retval]CMPRESULT *result)
 Register the process as belonging to CMP.
STDMETHODIMP UnregisterCMPProcess ([in]DWORD processId,[out, retval]CMPRESULT *result)
 Unregister the process as belonging to CMP.
STDMETHODIMP DetectCMPProcess ([in]DWORD processId,[out]VARIANT_BOOL *detectFlag,[out, retval]CMPRESULT *result)
 Detect if a process is using CMP.

Member Function Documentation

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

Close the session between the application and the mobile device.

Parameters:
resultresult of CMP call
Returns:
HRESULT

Reimplemented in CitrixMobile.

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

Detect if a process is using CMP.

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

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

Reimplemented in CitrixMobile.

STDMETHODIMP ISession::GetErrorText ( [in] CMP_ERROR_ID  ErrorId,
[out] BSTR *  ErrorText,
[out,retval] CMPRESULT result 
)

Retrieve text for error code - not implemented.

Parameters:
ErrorId
ErrorText
result
Returns:
HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ISession::GetSessionOptionBool ( [in] CMP_SESSION_OPTION  option,
[out] VARIANT_BOOL *  value,
[out,retval] CMPRESULT result 
)

Get session boolean option.

Parameters:
optionsession option
valuereturned boolean value for option
resultreturned CMP result
Returns:
HRESULT

Reimplemented in CitrixMobile.

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

Get the current state of the session.

Parameters:
sessionState
Returns:
HRESULT

Reimplemented in CitrixMobile.

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

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

Parameters:
sessionActive
Returns:
HRESULT

Reimplemented in CitrixMobile.

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

Open a session between the application and the mobile device.

Parameters:
resultreturn code of CMP call
Returns:
HRESULT

Reimplemented in CitrixMobile.

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

Register the process as belonging to CMP.

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

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

Reimplemented in CitrixMobile.

STDMETHODIMP ISession::SetSessionOptionBool ( [in] CMP_SESSION_OPTION  option,
[in] VARIANT_BOOL  value,
[out,retval] CMPRESULT result 
)

Set session boolean option.

Parameters:
optionsession option
valueboolean value for option
resultreturned CMP result
Returns:
HRESULT

Reimplemented in CitrixMobile.

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

Unregister the process as belonging to CMP.

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

Reimplemented in CitrixMobile.


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