All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATIVpmLoginSession
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIVpmLoginSession
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVpmLoginSession
This interface represents the working context of a logged-in user and its
LCA transaction.
Method Index
- o
Abort()
- Abort operation.
- o
Close()
- Close operation.
- o
GetCurrentProject(VPMIProject**)
- Set the current project.
- o
GetLogicalUser(CATUnicodeString&)
- This method replaces VPMSession::GetLogicalUser.
- o
IsCached()
-
- o
IsRefreshed()
- Is Refresh activated.
- o
IsSaveNeeded()
- Is save operation needed.
- o
RefreshContents()
- RefreshContents.
- o
Save()
- Save operation.
- o
SetCache()
-
- o
SetCurrentProject(VPMIProject*)
- Set the current project.
- o
SetRefresh()
-
- o
Start()
- Start operation.
- o
UnsetCache()
-
- o
UnsetRefresh()
- Deactivate the refresh.
- o
get_LoginSessionId(CATUnicodeString&)
- Get login session identifier.
Methods
o Abort
-
Abort operation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Abort is successful
- S_FALSE
- Nothing to abort
- E_FAIL
- An error occured during the process
o Close
-
Close operation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Close is successful
- E_FAIL
- An error occured during the process
o GetCurrentProject
-
Set the current project.
- Parameters:
-
- ioProject
- The retrieved VPMIProject to set
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Get is OK
o GetLogicalUser
-
This method replaces VPMSession::GetLogicalUser.
Get the logical User
- Parameters:
-
- oUser
- The name of the logical user
- Returns:
- An HRESULT value.
Legal values:
- S_OK
o IsCached
public virtual HRESULT IsCached( | )= 0 |
-
- Deprecated:
- V5R14
Is cache activated.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Cache is activated
- S_FALSE
- Cache is not activated
o IsRefreshed
public virtual HRESULT IsRefreshed( | )= 0 |
-
Is Refresh activated.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Refresh is activated
- S_FALSE
- Refresh is not activated
o IsSaveNeeded
public virtual HRESULT IsSaveNeeded( | )=0 |
-
Is save operation needed.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- At least one modification needs to be saved
- S_FALSE
- No modification needs to be saved
- E_FAIL
- An error occured during the process
o RefreshContents
public virtual HRESULT RefreshContents( | )=0 |
-
RefreshContents.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- At least one object needs to be refreshed
- S_FALSE
- No object needs to be refreshed
- E_FAIL
- An error occured during the process
o Save
-
Save operation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Save is successful
- S_FALSE
- Nothing to save
- E_FAIL
- An error occured during the process
o SetCache
public virtual HRESULT SetCache( | )= 0 |
-
- Deprecated:
- V5R14
Activate the cache.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Cache is activated
- S_FALSE
- Cache is already activated
- E_FAIL
- An error occured during the process
o SetCurrentProject
-
Set the current project.
- Parameters:
-
- iProject
- The VPMIProject to set
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Set is OK
o SetRefresh
public virtual HRESULT SetRefresh( | )= 0 |
-
- Deprecated:
- V5R14
Activate the refresh.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Refresh is activated
- S_FALSE
- Refresh is already activated
- E_FAIL
- An error occured during the process
o Start
-
Start operation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Start is successful
- E_FAIL
- An error occured during the process
o UnsetCache
public virtual HRESULT UnsetCache( | )= 0 |
-
- Deprecated:
- V5R14
Deactivate the cache.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Cache is deactivated
- S_FALSE
- Cache is already deactivated
- E_FAIL
- An error occured during the process
o UnsetRefresh
public virtual HRESULT UnsetRefresh( | )= 0 |
-
Deactivate the refresh.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Refresh is deactivated
- S_FALSE
- Refresh is already deactivated
- E_FAIL
- An error occured during the process
o get_LoginSessionId
-
Get login session identifier.
- Parameters:
-
- oLoginSessionId
- The login session identifier
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Identifier is defined
- S_FALSE
- An error occured during the process
This object is included in the file: CATIVpmLoginSession.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces