Skip to content

Latest commit

 

History

History
196 lines (115 loc) · 6.49 KB

ns-shlobj_core-shfoldercustomsettings.md

File metadata and controls

196 lines (115 loc) · 6.49 KB
Raw
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
NS:shlobj_core.SHFOLDERCUSTOMSETTINGS
SHFOLDERCUSTOMSETTINGS (shlobj_core.h)
Holds custom folder settings. This structure is used with the SHGetSetFolderCustomSettings function.
*LPSHFOLDERCUSTOMSETTINGS
FCSM_CLSID
FCSM_FLAGS
FCSM_ICONFILE
FCSM_INFOTIP
FCSM_LOGO
FCSM_VIEWID
FCSM_WEBVIEWTEMPLATE
LPSHFOLDERCUSTOMSETTINGS
LPSHFOLDERCUSTOMSETTINGS structure pointer [Windows Shell]
SHFOLDERCUSTOMSETTINGS
SHFOLDERCUSTOMSETTINGS structure [Windows Shell]
SHFOLDERCUSTOMSETTINGSA
SHFOLDERCUSTOMSETTINGSW
_win32_SHFOLDERCUSTOMSETTINGS
shell.SHFOLDERCUSTOMSETTINGS
shlobj_core/LPSHFOLDERCUSTOMSETTINGS
shlobj_core/SHFOLDERCUSTOMSETTINGS
shlobj_core/SHFOLDERCUSTOMSETTINGSA
shlobj_core/SHFOLDERCUSTOMSETTINGSW
shell\SHFOLDERCUSTOMSETTINGS.htm
shell
a6357372-80ef-4719-b53f-87eb3fdc1b0d
12/05/2018
*LPSHFOLDERCUSTOMSETTINGS, FCSM_CLSID, FCSM_FLAGS, FCSM_ICONFILE, FCSM_INFOTIP, FCSM_LOGO, FCSM_VIEWID, FCSM_WEBVIEWTEMPLATE, LPSHFOLDERCUSTOMSETTINGS, LPSHFOLDERCUSTOMSETTINGS structure pointer [Windows Shell], SHFOLDERCUSTOMSETTINGS, SHFOLDERCUSTOMSETTINGS structure [Windows Shell], SHFOLDERCUSTOMSETTINGSA, SHFOLDERCUSTOMSETTINGSW, _win32_SHFOLDERCUSTOMSETTINGS, shell.SHFOLDERCUSTOMSETTINGS, shlobj_core/LPSHFOLDERCUSTOMSETTINGS, shlobj_core/SHFOLDERCUSTOMSETTINGS, shlobj_core/SHFOLDERCUSTOMSETTINGSA, shlobj_core/SHFOLDERCUSTOMSETTINGSW
shlobj_core.h
Shlobj.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
SHFOLDERCUSTOMSETTINGSW (Unicode) and SHFOLDERCUSTOMSETTINGSA (ANSI)
Windows
SHFOLDERCUSTOMSETTINGS, *LPSHFOLDERCUSTOMSETTINGS
19H1
LPSHFOLDERCUSTOMSETTINGS
shlobj_core/LPSHFOLDERCUSTOMSETTINGS
SHFOLDERCUSTOMSETTINGS
shlobj_core/SHFOLDERCUSTOMSETTINGS
c++
APIRef
kbSyntax
HeaderDef
shlobj_core.h
SHFOLDERCUSTOMSETTINGS
SHFOLDERCUSTOMSETTINGSA
SHFOLDERCUSTOMSETTINGSW

SHFOLDERCUSTOMSETTINGS structure

-description

Holds custom folder settings. This structure is used with the SHGetSetFolderCustomSettings function.

-struct-fields

-field dwSize

Type: DWORD

The size of the structure, in bytes.

-field dwMask

Type: DWORD

A DWORD value specifying which folder attributes to read or write from this structure. Use one or more of the following values to indicate which structure members are valid:

FCSM_VIEWID

Deprecated. pvid contains the folder's GUID.

FCSM_WEBVIEWTEMPLATE

Deprecated. pszWebViewTemplate contains a pointer to a buffer containing the path to the folder's WebView template.

FCSM_INFOTIP

pszInfoTip contains a pointer to a buffer containing the folder's info tip.

FCSM_CLSID

pclsid contains the folder's CLSID.

FCSM_ICONFILE

pszIconFile contains the path to the file containing the folder's icon.

FCSM_LOGO

pszLogo contains the path to the file containing the folder's thumbnail icon.

FCSM_FLAGS

Not used.

-field pvid

Type: SHELLVIEWID*

The folder's GUID.

-field pszWebViewTemplate

Type: LPTSTR

A pointer to a null-terminated string containing the path to the folder's WebView template.

-field cchWebViewTemplate

Type: DWORD

If the SHGetSetFolderCustomSettings parameter dwReadWrite is FCS_READ, this is the size of the pszWebViewTemplate buffer, in characters. If not, this is the number of characters to write from that buffer. Set this parameter to 0 to write the entire string.

-field pszWebViewTemplateVersion

Type: LPTSTR

A pointer to a null-terminated buffer containing the WebView template version.

-field pszInfoTip

Type: LPTSTR

A pointer to a null-terminated buffer containing the text of the folder's infotip.

-field cchInfoTip

Type: DWORD

If the SHGetSetFolderCustomSettings parameter dwReadWrite is FCS_READ, this is the size of the pszInfoTip buffer, in characters. If not, this is the number of characters to write from that buffer. Set this parameter to 0 to write the entire string.

-field pclsid

Type: CLSID*

A pointer to a CLSID used to identify the folder in the Windows registry. Further folder information is stored in the registry under that CLSID entry.

-field dwFlags

Type: DWORD

Not used.

-field pszIconFile

Type: LPTSTR

A pointer to a null-terminated buffer containing the path to file containing the folder's icon.

-field cchIconFile

Type: DWORD

If the SHGetSetFolderCustomSettings parameter dwReadWrite is FCS_READ, this is the size of the pszIconFile buffer, in characters. If not, this is the number of characters to write from that buffer. Set this parameter to 0 to write the entire string.

-field iIconIndex

Type: int

The index of the icon within the file named in pszIconFile.

-field pszLogo

Type: LPTSTR

A pointer to a null-terminated buffer containing the path to the file containing the folder's logo image. This is the image used in thumbnail views.

-field cchLogo

Type: DWORD

If the SHGetSetFolderCustomSettings parameter dwReadWrite is FCS_READ, this is the size of the pszLogo buffer, in characters. If not, this is the number of characters to write from that buffer. Set this parameter to 0 to write the entire string.

-remarks

In Windows XP Service Pack 2 (SP2) and earlier versions, this structure supported both ANSI and Unicode strings. In Windows Vista and later versions, only Unicode strings are supported.