IBackgroundCopyJob::SetDisplayName method (bits.h)
Specifies a display name for the job. Typically, you use the display name to identify the job in a user interface.
Syntax
HRESULT SetDisplayName(
[in] LPCWSTR Val
);
Parameters
[in] Val
Null-terminated string that identifies the job. Must not be NULL. The length of the string is limited to 256 characters, not including the null terminator.
Return value
This method returns the following HRESULT values, as well as others.
| Return code | Description |
|---|---|
|
Display name was successfully set. |
|
The pDisplayName parameter cannot be NULL or the name exceeds 256 characters. |
|
The display name exceeds 256 characters. |
|
The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED. |
Remarks
The display name is originally set when you create the job. For details on specifying the display name when you create the job, see the IBackgroundCopyManager::CreateJob 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 |