(0) exportieren Drucken
Alle erweitern
EN
Dieser Inhalt ist in Ihrer Sprache leider nicht verfügbar. Im Folgenden finden Sie die englische Version.

IBackgroundCopyJob::SetDescription method

Provides a description of the job.

Syntax


HRESULT SetDescription(
  [in]  LPCWSTR pDescription
);

Parameters

pDescription [in]

Null-terminated string that provides additional information about the job. The length of the string is limited to 1,024 characters, not including the null terminator.

Return value

This method returns the following HRESULT values, as well as others.

Return codeDescription
S_OK

Description of the job was successfully set.

E_INVALIDARG

The pDescription parameter cannot be NULL.

BG_E_STRING_TOO_LONG

The description exceeds 1,024 characters.

BG_E_INVALID_STATE

The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

 

Examples

See the example code for the IBackgroundCopyManager::CreateJob method.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Bits.h

IDL

Bits.idl

Library

Bits.lib

DLL

QmgrPrxy.dll

IID

IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

IBackgroundCopyJob::GetDescription

 

 

Community-Beiträge

HINZUFÜGEN
Anzeigen:
© 2014 Microsoft