IBackgroundCopyJob::GetDisplayName method

Retrieves the display name for the job. Typically, you use the display name to identify the job in a user interface.

Syntax

HRESULT GetDisplayName(
  [out] LPWSTR *ppDisplayName
);

Parameters

ppDisplayName [out]

Null-terminated string that contains the display name that identifies the job. More than one job can have the same display name. Call the CoTaskMemFree function to free ppDisplayName when done.

Return value

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

Return code Description
S_OK
Display name was successfully retrieved.
E_INVALIDARG
The ppDisplayName parameter cannot be NULL.

Requirements

Requirement Value
Minimum supported client
Windows 10, version 1709 [desktop apps only]
Minimum supported server
Windows Server, version 1709 [desktop apps only]
Header
Deliveryoptimization.h
IDL
DeliveryOptimization.idl
Library
Dosvc.lib
DLL
Dosvc.dll
IID
IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

IBackgroundCopyJob