SHObjectProperties function (shlobj_core.h)

Article
02/22/2024

[SHObjectProperties is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Invokes the Properties context menu command on a Shell object.

Syntax

BOOL SHObjectProperties(
  [in] HWND   hwnd,
  [in] DWORD  shopObjectType,
  [in] PCWSTR pszObjectName,
  [in] PCWSTR pszPropertyPage
);

Parameters

[in] hwnd

Type: HWND

The handle of the parent window of the dialog box. This value can be NULL.

[in] shopObjectType

Type: DWORD

A flag value that specifies the type of object.

SHOP_PRINTERNAME

pszObjectName contains the friendly name of a printer.

SHOP_FILEPATH

pszObjectName contains a fully qualified file name.

SHOP_VOLUMEGUID

pszObjectName contains either (a) a volume name of the form \?\Volume{GUID}, where {GUID} is a globally unique identifier (for example, "\?\Volume{2eca078d-5cbc-43d3-aff8-7e8511f60d0e})", or (b) a drive path (for example, "C:").

[in] pszObjectName

Type: PCWSTR

A null-terminated Unicode string that contains the object name. The contents of the string are determined by the flag set in shopObjectType.

[in] pszPropertyPage

Type: PCWSTR

A null-terminated Unicode string that contains the name of the property sheet page to be opened initially. Set this parameter to NULL to specify the default page.

Return value

Type: BOOL

TRUE if the command is successfully invoked; otherwise, FALSE.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	shlobj_core.h (include Shlobj.h)
Library	Shell32.lib
DLL	Shell32.dll (version 5.0 or later)

Share via