PathSetDlgItemPathA function (shlwapi.h)

Article
02/22/2024

Sets the text of a child control in a window or dialog box, using PathCompactPath to ensure the path fits in the control.

Syntax

void PathSetDlgItemPathA(
  [in] HWND   hDlg,
  [in] int    id,
  [in] LPCSTR pszPath
);

Parameters

[in] hDlg

Type: HWND

A handle to the dialog box or window.

[in] id

Type: int

The identifier of the control.

[in] pszPath

Type: LPCSTR

A pointer to a null-terminated string of maximum length MAX_PATH that contains the path to set in the control.

Return value

None

Remarks

Note

The shlwapi.h header defines PathSetDlgItemPath as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlwapi.h
Library	Shlwapi.lib
DLL	Shlwapi.dll (version 4.71 or later)

Share via