Windows Shell Library
[Libraries]

---

Detailed Description

Created: 8th June 2006 Updated: 13th March 2007.

This library contains classes and functions for manipulation of the Windows Shell.

The library includes the following classes and functions:

• The winstl::basic_drophandle_sequence class template provides an STL-collection interface over the Windows Shell API drop handle functions.
• The winstl::browse_for_folder() function templates provide type-safe and easy to use wrappers for the SHBrowseForFolder API function.
• The winstl::shell_delete() function templates provide type-safe and easy to use wrappers for the SHFileOperation API function, which delete file(s) and, optionally, place them in the recycle bin. (The kernel function DeleteFile does not do this; it permanently deletes your file(s).)

Classes
struct	shell_browse_traits
	Traits for accessing the correct browse information functions for a given character type. More...
struct	drophandle_sequence_traits
	Traits for accessing the correct drop-handle functions for a given character type. More...
class	basic_drophandle_sequence_const_iterator
	Iterator for the basic_drophandle_sequence class. More...
class	basic_drophandle_sequence
	This class wraps an STL-like sequence interface over a Win32 drop handle. More...
Functions
template<typename S, typename C>
bool	browse_for_folder (S const &title, C *displayName, UINT flags, HWND hwndOwner, LPCITEMIDLIST pidlRoot)
	Browses the shell namespace according to the given parameters.
template<typename S0, typename C, typename S1>
bool	browse_for_folder (S0 const &title, C *displayName, UINT flags, HWND hwndOwner, LPCITEMIDLIST pidlRoot, S1 const &defaultFolder)
	Browses the shell namespace according to the given parameters.
template<typename S, typename C>
bool	browse_for_folder (S const &title, C *displayName, UINT flags, HWND hwndOwner)
	Browses the shell namespace according to the given parameters.
template<typename S, typename C>
bool	browse_for_folder (S const &title, C *displayName, UINT flags, LPCITEMIDLIST pidlRoot)
	Browses the shell namespace according to the given parameters.
template<typename S, typename C>
bool	browse_for_folder (S const &title, C *displayName, UINT flags)
	Browses the shell namespace according to the given parameters.
template<typename S0, typename C, typename S1>
bool	browse_for_folder (S0 const &title, C *displayName, UINT flags, S1 const &defaultFolder)
	Browses the shell namespace according to the given parameters.
template<typename S, typename C>
bool	browse_for_folder (S const &title, C *displayName)
	Browses the shell namespace according to the given parameters.
int	shell_delete (char const *from)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, char const *progressTitle)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, char const *progressTitle, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, char const *progressTitle, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (char const *from, char const *progressTitle, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, char const *progressTitle)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, char const *progressTitle, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, char const *progressTitle, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, char const *from, char const *progressTitle, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, wchar_t const *progressTitle)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, wchar_t const *progressTitle, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, wchar_t const *progressTitle, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (wchar_t const *from, wchar_t const *progressTitle, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, wchar_t const *progressTitle)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, wchar_t const *progressTitle, bool &bAborted)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, wchar_t const *progressTitle, FILEOP_FLAGS flags)
	Requests the shell to delete the given file.
int	shell_delete (HWND hwnd, wchar_t const *from, wchar_t const *progressTitle, FILEOP_FLAGS flags, bool &bAborted)
	Requests the shell to delete the given file.

---

Function Documentation

bool winstl::browse_for_folder	(	S const &	title,
		C *	displayName
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name

References winstl::browse_for_folder().

bool winstl::browse_for_folder	(	S0 const &	title,
		C *	displayName,
		UINT	flags,
		S1 const &	defaultFolder
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name
	flags	Combination of the BIF_* flags for the Win32 SHBrowseForFolder() function
	defaultFolder	The default folder to select when the browse window opens

References winstl::browse_for_folder().

bool winstl::browse_for_folder	(	S const &	title,
		C *	displayName,
		UINT	flags
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name
	flags	Combination of the BIF_* flags for the Win32 SHBrowseForFolder() function

References winstl::browse_for_folder().

bool winstl::browse_for_folder	(	S const &	title,
		C *	displayName,
		UINT	flags,
		LPCITEMIDLIST	pidlRoot
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name
	flags	Combination of the BIF_* flags for the Win32 SHBrowseForFolder() function
	pidlRoot	Pointer to an ITEMIDLIST structure (PIDL) specifying the location of the root folder from which to start browsing. May be null

References winstl::browse_for_folder().

bool winstl::browse_for_folder	(	S const &	title,
		C *	displayName,
		UINT	flags,
		HWND	hwndOwner
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name
	flags	Combination of the BIF_* flags for the Win32 SHBrowseForFolder() function
	hwndOwner	The parent of the browse dialog. May be null

References winstl::browse_for_folder().

bool winstl::browse_for_folder	(	S0 const &	title,
		C *	displayName,
		UINT	flags,
		HWND	hwndOwner,
		LPCITEMIDLIST	pidlRoot,
		S1 const &	defaultFolder
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name
	flags	Combination of the BIF_* flags for the Win32 SHBrowseForFolder() function
	hwndOwner	The parent of the browse dialog. May be null
	pidlRoot	Pointer to an ITEMIDLIST structure (PIDL) specifying the location of the root folder from which to start browsing. May be null
	defaultFolder	The default folder to select when the browse window opens

References stlsoft_ns_qual.

bool winstl::browse_for_folder	(	S const &	title,
		C *	displayName,
		UINT	flags,
		HWND	hwndOwner,
		LPCITEMIDLIST	pidlRoot
	)			[inline]

Browses the shell namespace according to the given parameters.

Parameters:

	title	The title for the browse dialog
	displayName	Buffer to receive the display name
	flags	Combination of the BIF_* flags for the Win32 SHBrowseForFolder() function
	hwndOwner	The parent of the browse dialog. May be null
	pidlRoot	Pointer to an ITEMIDLIST structure (PIDL) specifying the location of the root folder from which to start browsing. May be null

Examples:

by_library/windows_shell/shell_functions/shell_functions.cpp.

References stlsoft_ns_qual.

Referenced by winstl::browse_for_folder().

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		wchar_t const *	progressTitle,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		wchar_t const *	progressTitle,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		wchar_t const *	progressTitle,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		wchar_t const *	progressTitle
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored.

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored.

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		wchar_t const *	from
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		wchar_t const *	progressTitle,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		wchar_t const *	progressTitle,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		wchar_t const *	progressTitle,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		wchar_t const *	progressTitle
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored.

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	wchar_t const *	from,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete

(

wchar_t const *

from

)

[inline]

Requests the shell to delete the given file.

Parameters:

from

The file to delete

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		char const *	progressTitle,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		char const *	progressTitle,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		char const *	progressTitle,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		char const *	progressTitle
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	progressTitle	String to be displayed describing the operation

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored.

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored.

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	HWND	hwnd,
		char const *	from
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	hwnd	Handle to the window that will act as the parent to any dialogs displayed
	from	The file to delete

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		char const *	progressTitle,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		char const *	progressTitle,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored. The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		char const *	progressTitle,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		char const *	progressTitle
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	progressTitle	String to be displayed describing the operation

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The flag FOF_SIMPLEPROGRESS is automatically added if progressTitle is non-NULL

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		FILEOP_FLAGS	flags,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		FILEOP_FLAGS	flags
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	flags	One or more of the FILEOP_FLAGS values.

Note:

Throws std::bad_alloc on allocation failure on translators that support it

The FOF_WANTMAPPINGHANDLE flag is always ignored.

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete	(	char const *	from,
		bool &	bAborted
	)			[inline]

Requests the shell to delete the given file.

Parameters:

	from	The file to delete
	bAborted	A Boolean that will indicate whether the operation was aborted

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

int winstl::shell_delete

(

char const *

from

)

[inline]

Requests the shell to delete the given file.

Parameters:

from

The file to delete

Note:

Throws std::bad_alloc on allocation failure on translators that support it

Returns:

A status code indicating the success of the operation

Return values:

	0	The operation completed successfully
	ERROR_NOT_ENOUGH_MEMORY	This is returned only when compiling with translators that do not support throwing std::bad_alloc on memory allocation failure
	!0	Any other Win32 error code

Examples:

by_library/windows_shell/shell_functions/shell_functions.cpp.