Skip to content

Latest commit

 

History

History
93 lines (69 loc) · 3.04 KB

nf-shlobj_core-iprogressdialog-setline.md

File metadata and controls

93 lines (69 loc) · 3.04 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shlobj_core.IProgressDialog.SetLine
IProgressDialog::SetLine (shlobj_core.h)
Displays a message in the progress dialog.
IProgressDialog interface [Windows Shell]
SetLine method
IProgressDialog.SetLine
IProgressDialog::SetLine
SetLine
SetLine method [Windows Shell]
SetLine method [Windows Shell]
IProgressDialog interface
_win32_IProgressDialog_SetLine
shell.IProgressDialog_SetLine
shlobj_core/IProgressDialog::SetLine
shell\IProgressDialog_SetLine.htm
shell
2c4441a8-3bb6-4cd8-8f96-423ee8d26113
12/05/2018
IProgressDialog interface [Windows Shell],SetLine method, IProgressDialog.SetLine, IProgressDialog::SetLine, SetLine, SetLine method [Windows Shell], SetLine method [Windows Shell],IProgressDialog interface, _win32_IProgressDialog_SetLine, shell.IProgressDialog_SetLine, shlobj_core/IProgressDialog::SetLine
shlobj_core.h
Windows
Windows 2000 Professional, Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Shell32.dll (version 5.0 or later)
Windows
19H1
IProgressDialog::SetLine
shlobj_core/IProgressDialog::SetLine
c++
APIRef
kbSyntax
COM
Shell32.dll
IProgressDialog.SetLine

IProgressDialog::SetLine

-description

Displays a message in the progress dialog.

-parameters

-param dwLineNum

Type: DWORD

The line number on which the text is to be displayed. Currently there are three lines—1, 2, and 3. If the PROGDLG_AUTOTIME flag was included in the dwFlags parameter when IProgressDialog::StartProgressDialog was called, only lines 1 and 2 can be used. The estimated time will be displayed on line 3.

-param pwzString [in]

Type: PCWSTR

A null-terminated Unicode string that contains the text.

-param fCompactPath

Type: BOOL

TRUE to have path strings compacted if they are too large to fit on a line. The paths are compacted with PathCompactPath.

-param pvResevered

Type: LPCVOID

Reserved. Set to NULL.

-returns

Type: HRESULT

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

-remarks

This function is typically used to display a message such as "Item XXX is now being processed." typically, messages are displayed on lines 1 and 2, with line 3 reserved for the estimated time.

-see-also

IProgressDialog