IBackgroundCopyJob2::GetNotifyCmdLine method (bits1_5.h)
Retrieves the program to execute when the job enters the error or transferred state.
Syntax
HRESULT GetNotifyCmdLine(
[out] LPWSTR *pProgram,
[out] LPWSTR *pParameters
);
Parameters
[out] pProgram
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.
[out] pParameters
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2003 |
| Target Platform | Windows |
| Header | bits1_5.h (include Bits.h) |
| Library | Bits.lib |
| DLL | BitsPrx2.dll |
| Redistributable | BITS 1.5 on Windows XP |