GetError method of the BitsClientJob class

  • Article

The GetError method gets the error codes and error context for a BITS transfer job error.

Syntax

uint32 GetError(
  [in]  uint32 LanguageId,
  [out] uint32 ErrorContext,
  [out] uint32 ErrorCode,
  [out] string ContextDescription,
  [out] string ErrorDescription
);

Parameters

LanguageId [in]

Identifies the language locale used to generate the error description.

ErrorContext [out]

Specifies the context in which the error occurred. The following values are possible:

Error context Meaning
0
 An error has not occurred.
1
 The error context is unknown.
2
 The transfer queue manager generated the error.
3
 The error was generated while the queue manager was notifying the client of an event.
4
 The error was related to the specified local file. For example, permission was denied or the volume was unavailable.
5
 The error was related to the remote file. For example, the URL was not accessible.
6
 The transport layer generated the error. These errors are general transport errors.
7
 The server application, to which BITS passed the upload file, generated an error while processing the upload file.

ErrorCode [out]

Specifies the error code that resulted in the BITS transfer job entering an error state.

ContextDescription [out]

Specifies the description of the context in which the error occurred.

ErrorDescription [out]

Specifies the description of the error code that resulted in the BITS transfer job entering an error state.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008 R2
Redistributable
 Windows Management Framework on Windows Server 2008 with SP2
Namespace
 Root\microsoft\bits
MOF
BitsProvider.mof

See also

BitsClientJob