Edit

Share via

IBackgroundCopyJob5::SetProperty method (bits5_0.h)

  • Article

A generic method for setting BITS job properties.

Syntax

HRESULT SetProperty(
  [in] BITS_JOB_PROPERTY_ID    PropertyId,
  [in] BITS_JOB_PROPERTY_VALUE PropertyValue
);

Parameters

[in] PropertyId

The ID of the property that is being set specified as a BITS_JOB_PROPERTY_ID enum value.

[in] PropertyValue

The value of the property that is being set. In order to hold a value whose type is appropriate to the property, this value is specified via the BITS_JOB_PROPERTY_VALUE union that is composed of all the known property types.

Return value

The method returns the following return values.

Return code Description
S_OK
 Success

Requirements

Requirement Value
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header bits5_0.h (include Bits.h)
Library Bits.lib

See also

IBackgroundCopyJob5

IBackgroundCopyJob5::GetProperty