IBackgroundCopyJob2::GetNotifyCmdLine method
Retrieves the program to execute when the job enters the error or transferred state.
Syntax
HRESULT GetNotifyCmdLine(
[out] LPWSTR *pProgram,
[out] LPWSTR *pParameters
);
Parameters
pProgram [out]
Null-terminated string that contains the program to execute when the job enters the error or transferred state. Call the CoTaskMemFree function to free pProgram when done.pParameters [out]
Null-terminated string that contains the arguments of the program in pProgram. Call the CoTaskMemFree function to free pParameters when done.
Return value
This method returns S_OK on success or one of the standard COM HRESULT values on error.
Remarks
The GetNotifyCmdLine method sets pProgram and pParameters to an empty string (L"") if the IBackgroundCopyJob2::SetNotifyCmdLine method has not been called.
Requirements
Minimum supported client |
Windows 10, version 1709 [desktop apps only] |
Minimum supported server |
Windows Server 2016 [desktop apps only] |
Header |
Deliveryoptimization.h |
IDL |
DeliveryOptimization.idl |
Library |
Dosvc.lib |
DLL |
Dosvc.dll |
IID |
IID_IBackgroundCopyJob2 is defined as 54B50739-686F-45EB-9DFF-D6A9A0FAA9AF |