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

See also

IBackgroundCopyJob2

IBackgroundCopyJob2::SetNotifyCmdLine