Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSJobManager Interface Reference

Inherited by IDSSJobManager2.

List of all members.

Public Member Functions

HRESULT Close ([in] DssJobId JobID,[in, optional, defaultvalue(DssCloseJobNormal)] EnumDSSCloseJobOption CloseJobOption)
 This method close the job identified by the given job id.
HRESULT GetJobs ([in] EnumDSSGetJobOptions iSelection,[in] Int32 MaxCount,[in] EnumDSSRefreshOption RefreshOption,[out, retval] IDSSJobs ppDSSJobs)
HRESULT GetUserJobs ([in] BSTR UserName,[in] EnumDSSGetJobOptions iSelection,[in] Int32 MaxCount,[in] EnumDSSRefreshOption RefreshOption,[out, retval] IDSSJobs ppDSSJobs)
HRESULT RefreshJob ([in] DssJobId iJobId,[in] EnumDSSGetJobOptions JobOption,[in] EnumDSSRefreshOption RefreshOption,[out, retval] IDSSJob ppJob)
 This method refresh the information of a given job.


Member Function Documentation

HRESULT IDSSJobManager::Close [in] DssJobId  JobID,
[in, optional, defaultvalue(DssCloseJobNormal)] EnumDSSCloseJobOption  CloseJobOption
 

This method close the job identified by the given job id.

CloseJobOption takes a value from EnumDSSCloseJobOption
Constant Value Comment
DssCloseJobNormal 0 Reserved.
DssCloseJobImmediate 1 Cancel this job.
Parameters:
JobID Job ID of the job to be closed.
CloseJobOption Different options to close the job.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSJobManager::GetJobs [in] EnumDSSGetJobOptions  iSelection,
[in] Int32  MaxCount,
[in] EnumDSSRefreshOption  RefreshOption,
[out, retval] IDSSJobs   ppDSSJobs
 

HRESULT IDSSJobManager::GetUserJobs [in] BSTR  UserName,
[in] EnumDSSGetJobOptions  iSelection,
[in] Int32  MaxCount,
[in] EnumDSSRefreshOption  RefreshOption,
[out, retval] IDSSJobs   ppDSSJobs
 

HRESULT IDSSJobManager::RefreshJob [in] DssJobId  iJobId,
[in] EnumDSSGetJobOptions  JobOption,
[in] EnumDSSRefreshOption  RefreshOption,
[out, retval] IDSSJob   ppJob
 

This method refresh the information of a given job.

Parameters:
iJobId The job ID of the job to be refreshed.
JobOption Job selection options
RefreshOption Job refresh options
ppJob The interface to the job to be refreshed.
Returns:
Usual COM result code:
  • S_OK


Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.