Edit

IAttachmentExecute::Prompt method (shobjidl_core.h)

  • Article

Presents a prompt UI to the user.

Syntax

HRESULT Prompt(
  [in]  HWND              hwnd,
  [in]  ATTACHMENT_PROMPT prompt,
  [out] ATTACHMENT_ACTION *paction
);

Parameters

[in] hwnd

Type: HWND

A handle to the parent window.

[in] prompt

Type: ATTACHMENT_PROMPT

A member of the ATTACHMENT_PROMPT enumeration that indicates what type of prompt UI to display to the user.

[out] paction

Type: ATTACHMENT_ACTION*

A member of the ATTACHMENT_ACTION enumeration that indicates the action to be performed upon user confirmation.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

You must call IAttachmentExecute::SetFileName or IAttachmentExecute::SetLocalPath before calling IAttachmentExecute::Prompt.

IAttachmentExecute::Prompt can be called by the application to force UI presentation before the file has been copied to disk.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)
DLL Shdocvw.dll (version 6.0 or later)