Metode IBackgroundCopyJob::SetDisplayName (bits.h)

  • Artikel

Menentukan nama tampilan untuk pekerjaan tersebut. Biasanya, Anda menggunakan nama tampilan untuk mengidentifikasi pekerjaan di antarmuka pengguna.

Sintaks

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

Parameter

[in] Val

String yang dihentikan null yang mengidentifikasi pekerjaan. Tidak boleh NULL. Panjang string dibatasi hingga 256 karakter, tidak termasuk terminator null.

Nilai kembali

Metode ini mengembalikan nilai HRESULT berikut, serta yang lain.

Menampilkan kode Deskripsi
S_OK
 Nama tampilan berhasil disetel.
E_INVALIDARG
 Parameter pDisplayName tidak boleh NULL atau nama melebihi 256 karakter.
BG_E_STRING_TOO_LONG
 Nama tampilan melebihi 256 karakter.
BG_E_INVALID_STATE
 Status pekerjaan tidak dapat BG_JOB_STATE_CANCELLED atau BG_JOB_STATE_ACKNOWLEDGED.

Keterangan

Nama tampilan awalnya diatur saat Anda membuat pekerjaan. Untuk detail tentang menentukan nama tampilan saat Anda membuat pekerjaan, lihat metode IBackgroundCopyManager::CreateJob .

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows XP
Server minimum yang didukung Windows Server 2003
Target Platform Windows
Header bits.h
Pustaka Bits.lib
DLL QmgrPrxy.dll

Lihat juga

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob