Edit

IFileDialogCustomize::GetEditBoxText method (shobjidl_core.h)

  • Article

Gets the current text in an edit box control.

Syntax

HRESULT GetEditBoxText(
  [in]  DWORD dwIDCtl,
  [out] WCHAR **ppszText
);

Parameters

[in] dwIDCtl

Type: DWORD

The ID of the edit box.

[out] ppszText

Type: WCHAR**

The address of a pointer to a buffer that receives the text as a null-terminated Unicode string.

Return value

Type: HRESULT

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

Remarks

It is the responsibility of the calling application to free the buffer referenced by ppszText when it is no longer needed. Use CoTaskMemFree to free the buffer.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)