Edit

Share via

IActiveDesktop::GetPattern method (shlobj_core.h)

  • Article

Gets the current pattern.

Syntax

HRESULT GetPattern(
  [out] PWSTR pwszPattern,
        UINT  cchPattern,
        DWORD dwReserved
);

Parameters

[out] pwszPattern

Type: PWSTR

A pointer to a null-terminated, Unicode buffer containing a string of decimals whose bit pattern represents a picture. Each decimal represents the on/off state of the 8 pixels in that row.

cchPattern

Type: UINT

The size of the pwszPattern string, in characters.

dwReserved

Type: DWORD

Reserved. Must be set to zero.

Return value

Type: HRESULT

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

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 shlobj_core.h
DLL Shell32.dll (version 4.71 or later)