IDSSDocumentSourceEvents Interface Reference

List of all members.

---

Detailed Description

This dispinterface contains the events that can be triggered by a Document source object.

These events are used to signal the result, and progress of an asynchronous execution.

NOTE: This interface is defined for future expansion and is not currently used.

Public Member Functions
HRESULT	ExecutionCanceled ([in] IDSSDocumentInstance *pInstance,[in] Int32 UserData)
	Event fired when Document execution is cancelled.
HRESULT	ExecutionComplete ([in] IDSSDocumentInstance *pInstance,[in] Int32 UserData,[in] Int32 ResultCode)
	Event fired when Document execution is completed.
HRESULT	ExecutionFailed ([in] IDSSDocumentInstance *pInstance,[in] Int32 UserData,[in] Int32 ErrCode,[in] BSTR ErrDescription,[in] BSTR ErrSource)
	Event fired if error occurs during Document execution.
HRESULT	ProgressNotification ([in] IDSSDocumentInstance *pInstance,[in] Int32 UserData,[in] BSTR MessageString,[in] Int32 MessageID)
	Event fired on arrival of a progress notification message.
HRESULT	ResolvePrompts ([in] IDSSDocumentInstance *pInstance,[in] IDSSResolution *pResolution,[in] Int32 UserData,[out, retval] EnumDSSPromptAction *pResult)
	Event fired when Document execution is paused to answer prompts.

---

Member Function Documentation

HRESULT IDSSDocumentSourceEvents::ExecutionCanceled (  [in] IDSSDocumentInstance *  pInstance, [in] Int32  UserData )

Event fired when Document execution is cancelled. NOTE: Not currently used. Parameters: pInstance  The Document instance that is being executed. UserData  The identification number for the execution. Returns: Usual COM result code: S_OK

HRESULT IDSSDocumentSourceEvents::ExecutionComplete (  [in] IDSSDocumentInstance *  pInstance, [in] Int32  UserData, [in] Int32  ResultCode )

Event fired when Document execution is completed. NOTE: Not currently used. Parameters: pInstance  The Document instance that is being executed. UserData  The identification number for the execution. ResultCode  The result code from the execution. Returns: Usual COM result code: S_OK

HRESULT IDSSDocumentSourceEvents::ExecutionFailed (  [in] IDSSDocumentInstance *  pInstance, [in] Int32  UserData, [in] Int32  ErrCode, [in] BSTR  ErrDescription, [in] BSTR  ErrSource )

Event fired if error occurs during Document execution. NOTE: Not currently used. Parameters: pInstance  The Document instance that is being executed. UserData  The identification number for the execution. ErrCode  The error code returned by the execution if any. ErrDescription  The description of the error happens if any. ErrSource  The component in which the error happened. Returns: Usual COM result code: S_OK

HRESULT IDSSDocumentSourceEvents::ProgressNotification (  [in] IDSSDocumentInstance *  pInstance, [in] Int32  UserData, [in] BSTR  MessageString, [in] Int32  MessageID )

Event fired on arrival of a progress notification message. NOTE: Not currently used. Parameters: pInstance  The Document instance which is being executed UserData  The identification number of the execution. MessageString  The string of the notification message. MessageID  The ID of the message Returns: Usual COM result code: S_OK

HRESULT IDSSDocumentSourceEvents::ResolvePrompts (  [in] IDSSDocumentInstance *  pInstance, [in] IDSSResolution *  pResolution, [in] Int32  UserData, [out, retval] EnumDSSPromptAction *  pResult )

Event fired when Document execution is paused to answer prompts. NOTE: Not currently used. Parameters: pInstance  The Document instance that is being executed. pResolution  The resolution object containing the prompts that need answers. UserData  The identification number for the execution. pResult  Return whether to abort, pause or continue execution. Returns: Usual COM result code: S_OK

---