SHCreateDirectoryEx Function ()

SHCreateDirectoryEx Function

SHCreateDirectoryEx Function

Creates a new file system folder.

Syntax

int SHCreateDirectoryEx(      
    HWND hwnd,
    LPCTSTR pszPath,
    const SECURITY_ATTRIBUTES *psa
);

Parameters

hwnd
[in] A handle to a parent window. This parameter can be set to NULL if no user interface will be displayed.
pszPath
[in] A pointer to a null-terminated string specifying the fully qualified path of the directory. This string is of maximum length of 248 characters, including the terminating null character.
psa
[in] A pointer to a SECURITY_ATTRIBUTES structure with the directory's security attribute. Set this parameter to NULL if no security attributes need to be set.

Return Value

Returns ERROR_SUCCESS if successful. If the operation fails, other error codes can be returned, including those listed here. For values not specifically listed, see System Error Codes.
ERROR_BAD_PATHNAME The pszPath parameter was set to a relative path.
ERROR_FILENAME_EXCED_RANGE The path pointed to by pszPath is too long.
ERROR_PATH_NOT_FOUND The system cannot find the path pointed to by pszPath. The path may contain an invalid entry.
ERROR_FILE_EXISTS The directory exists.
ERROR_ALREADY_EXISTS The directory exists.
ERROR_CANCELLED The user canceled the operation.

Remarks

Note This function is available through Microsoft Windows XP Service Pack 2 (SP2) and Windows Server 2003. It might be altered or unavailable in subsequent versions of Windows.
This function creates a file system folder whose fully qualified path is given by pszPath. If one or more of the intermediate folders do not exist, they are created as well. SHCreateDirectoryEx also verifies that the files are visible. If they are not visible, expect one of the following:
If hwnd is set to a valid window handle, a message box is displayed warning the user that he or she might not be able to access the files. If the user chooses not to proceed, the function returns ERROR_CANCELLED.
If hwnd is set to NULL, no user interface is displayed and the function returns ERROR_CANCELLED.

Function Information

Minimum DLL Version shell32.dll version 5.0 or later
Custom Implementation No
Header shlobj.h
Import library shell32.lib
Minimum operating systems Windows 2000, Windows Millennium Edition
Unicode Implemented as ANSI and Unicode versions.

ERROR_BAD_PATHNAME	The pszPath parameter was set to a relative path.
ERROR_FILENAME_EXCED_RANGE	The path pointed to by pszPath is too long.
ERROR_PATH_NOT_FOUND	The system cannot find the path pointed to by pszPath. The path may contain an invalid entry.
ERROR_FILE_EXISTS	The directory exists.
ERROR_ALREADY_EXISTS	The directory exists.
ERROR_CANCELLED	The user canceled the operation.

Minimum DLL Version	shell32.dll version 5.0 or later
Custom Implementation	No
Header	shlobj.h
Import library	shell32.lib
Minimum operating systems	Windows 2000, Windows Millennium Edition
Unicode	Implemented as ANSI and Unicode versions.