Export (0) Print
Expand All

PathIsSystemFolder function

Determines if an existing folder contains the attributes that make it a system folder. Alternately, this function indicates if certain attributes qualify a folder to be a system folder.

Syntax


BOOL PathIsSystemFolder(
  _In_opt_  LPCTSTR pszPath,
  _In_      DWORD dwAttrb
);

Parameters

pszPath [in, optional]

Type: LPCTSTR

A pointer to a null-terminated string of maximum length MAX_PATH that contains the name of an existing folder. The attributes for this folder will be retrieved and compared with those that define a system folder. If this folder contains the attributes to make it a system folder, the function returns nonzero. If this value is NULL, this function determines if the attributes passed in dwAttrb qualify it to be a system folder.

dwAttrb [in]

Type: DWORD

The file attributes to be compared. Used only if pszPath is NULL. In that case, the attributes passed in this value are compared with those that qualify a folder as a system folder. If the attributes are sufficient to make this a system folder, this function returns nonzero. These attributes are the attributes that are returned from GetFileAttributes.

Return value

Type: BOOL

Returns nonzero if the pszPath or dwAttrb represent a system folder, or zero otherwise.

Requirements

Minimum supported client

Windows 2000 Professional, Windows XP [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Shlwapi.h

Library

Shlwapi.lib

DLL

Shlwapi.dll (version 4.71 or later)

Unicode and ANSI names

PathIsSystemFolderW (Unicode) and PathIsSystemFolderA (ANSI)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft