IBackgroundCopyJob::SetNotifyFlags method (bits.h)
Specifies the type of event notification you want to receive, such as job transferred events.
Syntax
HRESULT SetNotifyFlags(
[in] ULONG Val
);
Parameters
[in] Val
Set one or more of the following flags to identify the events that you want to receive.
Value | Meaning |
---|---|
|
All of the files in the job have been transferred. |
|
An error has occurred. |
|
Event notification is disabled. BITS ignores the other flags. |
|
The job has been modified. For example, a property value changed, the state of the job changed, or progress is made transferring the files. This flag is ignored in command-line callbacks if command line notification is specified. |
|
A file in the job has been transferred. This flag is ignored in command-line callbacks if command line notification is specified. |
|
A range of bytes in the file has been transferred. This flag is ignored in command-line callbacks if command line notification is specified. The flag can be specified for any job, but you will only get notifications for jobs that meet the requirements for a BITS_JOB_PROPERTY_ON_DEMAND_MODE job. |
Return value
This method returns the following HRESULT values, as well as others.
Return code | Description |
---|---|
|
Type of event notification was successfully set. |
|
The NotifyFlags value is not valid. |
|
The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED. |
Remarks
Use the SetNotifyFlags method in conjunction with the IBackgroundCopyJob::SetNotifyInterface and IBackgroundCopyJob2::SetNotifyCmdLine methods to receive event notification.
Examples
See the example code for the IBackgroundCopyJob::SetNotifyInterface method.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows XP |
Minimum supported server | Windows Server 2003 |
Target Platform | Windows |
Header | bits.h |
Library | Bits.lib |
DLL | QmgrPrxy.dll |
See also
IBackgroundCopyJob2::SetNotifyCmdLine