[ros-diffs] [akhaldi] 59748: [PSDK] * Annotate shellapi.h.

Author: akhaldi
Date: Thu Aug 15 21:43:06 2013
New Revision: 59748

URL: http://svn.reactos.org/svn/reactos?rev=59748&view=rev
Log:
[PSDK]
* Annotate shellapi.h.

Modified:
    trunk/reactos/include/psdk/shellapi.h

Modified: trunk/reactos/include/psdk/shellapi.h
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/include/psdk/shellapi.h?re…
==============================================================================
--- trunk/reactos/include/psdk/shellapi.h	[iso-8859-1] (original)
+++ trunk/reactos/include/psdk/shellapi.h	[iso-8859-1] Thu Aug 15 21:43:06 2013
@@ -369,46 +369,223 @@
 #define SHGNLI_NOUNIQUE    0x04
 #define SHGNLI_NOLNK       0x08
 
-BOOL WINAPI SHGetNewLinkInfoA(LPCSTR,LPCSTR,LPSTR,BOOL*,UINT);
-BOOL WINAPI SHGetNewLinkInfoW(LPCWSTR,LPCWSTR,LPWSTR,BOOL*,UINT);
-
-LPWSTR * WINAPI CommandLineToArgvW(LPCWSTR,int*);
-void WINAPI DragAcceptFiles(HWND,BOOL);
-void WINAPI DragFinish(HDROP);
-UINT WINAPI DragQueryFileA(HDROP,UINT,LPSTR,UINT);
-UINT WINAPI DragQueryFileW(HDROP,UINT,LPWSTR,UINT);
-BOOL WINAPI DragQueryPoint(HDROP,LPPOINT);
-HICON WINAPI ExtractAssociatedIconA(HINSTANCE,LPSTR,PWORD);
-HICON WINAPI ExtractAssociatedIconW(HINSTANCE,LPWSTR,PWORD);
-HICON WINAPI ExtractIconA(HINSTANCE,LPCSTR,UINT);
-HICON WINAPI ExtractIconW(HINSTANCE,LPCWSTR,UINT);
-UINT WINAPI ExtractIconExA(LPCSTR,int,HICON*,HICON*,UINT);
-UINT WINAPI ExtractIconExW(LPCWSTR,int,HICON*,HICON*,UINT);
-HINSTANCE WINAPI FindExecutableA(LPCSTR,LPCSTR,LPSTR);
-HINSTANCE WINAPI FindExecutableW(LPCWSTR,LPCWSTR,LPWSTR);
-UINT_PTR WINAPI SHAppBarMessage(DWORD,PAPPBARDATA);
-BOOL WINAPI Shell_NotifyIconA(DWORD,PNOTIFYICONDATAA);
-BOOL WINAPI Shell_NotifyIconW(DWORD,PNOTIFYICONDATAW);
-int WINAPI ShellAboutA(HWND,LPCSTR,LPCSTR,HICON);
-int WINAPI ShellAboutW(HWND,LPCWSTR,LPCWSTR,HICON);
-int WINAPI ShellMessageBoxA(HINSTANCE,HWND,LPCSTR,LPCSTR,UINT,...);
-int WINAPI ShellMessageBoxW(HINSTANCE,HWND,LPCWSTR,LPCWSTR,UINT,...);
-HINSTANCE WINAPI ShellExecuteA(HWND,LPCSTR,LPCSTR,LPCSTR,LPCSTR,INT);
-HINSTANCE WINAPI ShellExecuteW(HWND,LPCWSTR,LPCWSTR,LPCWSTR,LPCWSTR,INT);
-BOOL WINAPI ShellExecuteExA(LPSHELLEXECUTEINFOA);
-BOOL WINAPI ShellExecuteExW(LPSHELLEXECUTEINFOW);
-int WINAPI SHFileOperationA(LPSHFILEOPSTRUCTA);
-int WINAPI SHFileOperationW(LPSHFILEOPSTRUCTW);
-void WINAPI SHFreeNameMappings(HANDLE);
-DWORD_PTR WINAPI SHGetFileInfoA(LPCSTR,DWORD,SHFILEINFOA*,UINT,UINT);
-DWORD_PTR WINAPI SHGetFileInfoW(LPCWSTR,DWORD,SHFILEINFOW*,UINT,UINT);
-BOOL WINAPI SHGetNewLinkInfoA(LPCSTR,LPCSTR,LPSTR,BOOL*,UINT);
-BOOL WINAPI SHGetNewLinkInfoW(LPCWSTR,LPCWSTR,LPWSTR,BOOL*,UINT);
-HRESULT WINAPI SHQueryRecycleBinA(LPCSTR, LPSHQUERYRBINFO);
-HRESULT WINAPI SHQueryRecycleBinW(LPCWSTR, LPSHQUERYRBINFO);
-HRESULT WINAPI SHEmptyRecycleBinA(HWND,LPCSTR,DWORD);
-HRESULT WINAPI SHEmptyRecycleBinW(HWND,LPCWSTR,DWORD);
-BOOL WINAPI SHCreateProcessAsUserW(PSHCREATEPROCESSINFOW);
+LPWSTR * WINAPI CommandLineToArgvW(_In_ LPCWSTR, _Out_ int*);
+void WINAPI DragAcceptFiles(_In_ HWND, _In_ BOOL);
+void WINAPI DragFinish(_In_ HDROP);
+
+_Success_(return != 0)
+UINT
+WINAPI
+DragQueryFileA(
+  _In_ HDROP hDrop,
+  _In_ UINT iFile,
+  _Out_writes_opt_(cch) LPSTR lpszFile,
+  _In_ UINT cch);
+
+_Success_(return != 0)
+UINT
+WINAPI
+DragQueryFileW(
+  _In_ HDROP hDrop,
+  _In_ UINT iFile,
+  _Out_writes_opt_(cch) LPWSTR lpszFile,
+  _In_ UINT cch);
+
+BOOL WINAPI DragQueryPoint(_In_ HDROP, _Out_ LPPOINT);
+
+HICON
+WINAPI
+ExtractAssociatedIconA(
+  _Reserved_ HINSTANCE hInst,
+  _Inout_updates_(128) LPSTR pszIconPath,
+  _Inout_ WORD *piIcon);
+
+HICON
+WINAPI
+ExtractAssociatedIconW(
+  _Reserved_ HINSTANCE hInst,
+  _Inout_updates_(128) LPWSTR pszIconPath,
+  _Inout_ WORD *piIcon);
+
+HICON
+WINAPI
+ExtractIconA(
+  _Reserved_ HINSTANCE hInst,
+  _In_ LPCSTR pszExeFileName,
+  UINT nIconIndex);
+
+HICON
+WINAPI
+ExtractIconW(
+  _Reserved_ HINSTANCE hInst,
+  _In_ LPCWSTR pszExeFileName,
+  UINT nIconIndex);
+
+UINT
+WINAPI
+ExtractIconExA(
+  _In_ LPCSTR lpszFile,
+  _In_ int nIconIndex,
+  _Out_writes_opt_(nIcons) HICON *phiconLarge,
+  _Out_writes_opt_(nIcons) HICON *phiconSmall,
+  _In_ UINT nIcons);
+
+UINT
+WINAPI
+ExtractIconExW(
+  _In_ LPCWSTR lpszFile,
+  _In_ int nIconIndex,
+  _Out_writes_opt_(nIcons) HICON *phiconLarge,
+  _Out_writes_opt_(nIcons) HICON *phiconSmall,
+  _In_ UINT nIcons);
+
+_Success_(return > 32)
+HINSTANCE
+WINAPI
+FindExecutableA(
+  _In_ LPCSTR lpFile,
+  _In_opt_ LPCSTR lpDirectory,
+  _Out_writes_(MAX_PATH) LPSTR lpResult);
+
+_Success_(return > 32)
+HINSTANCE
+WINAPI
+FindExecutableW(
+  _In_ LPCWSTR lpFile,
+  _In_opt_ LPCWSTR lpDirectory,
+  _Out_writes_(MAX_PATH) LPWSTR lpResult);
+
+UINT_PTR WINAPI SHAppBarMessage(_In_ DWORD, _Inout_ PAPPBARDATA);
+BOOL WINAPI Shell_NotifyIconA(_In_ DWORD, _In_ PNOTIFYICONDATAA);
+BOOL WINAPI Shell_NotifyIconW(_In_ DWORD, _In_ PNOTIFYICONDATAW);
+
+int
+WINAPI
+ShellAboutA(
+  _In_opt_ HWND hWnd,
+  _In_ LPCSTR szApp,
+  _In_opt_ LPCSTR szOtherStuff,
+  _In_opt_ HICON hIcon);
+
+int
+WINAPI
+ShellAboutW(
+  _In_opt_ HWND hWnd,
+  _In_ LPCWSTR szApp,
+  _In_opt_ LPCWSTR szOtherStuff,
+  _In_opt_ HICON hIcon);
+
+int
+WINAPI
+ShellMessageBoxA(
+  _In_opt_ HINSTANCE hAppInst,
+  _In_opt_ HWND hWnd,
+  _In_ LPCSTR lpcText,
+  _In_opt_ LPCSTR lpcTitle,
+  _In_ UINT fuStyle,
+  ...);
+
+int
+WINAPI
+ShellMessageBoxW(
+  _In_opt_ HINSTANCE hAppInst,
+  _In_opt_ HWND hWnd,
+  _In_ LPCWSTR lpcText,
+  _In_opt_ LPCWSTR lpcTitle,
+  _In_ UINT fuStyle,
+  ...);
+
+HINSTANCE
+WINAPI
+ShellExecuteA(
+  _In_opt_ HWND hwnd,
+  _In_opt_ LPCSTR lpOperation,
+  _In_ LPCSTR lpFile,
+  _In_opt_ LPCSTR lpParameters,
+  _In_opt_ LPCSTR lpDirectory,
+  _In_ INT nShowCmd);
+
+HINSTANCE
+WINAPI
+ShellExecuteW(
+  _In_opt_ HWND hwnd,
+  _In_opt_ LPCWSTR lpOperation,
+  _In_ LPCWSTR lpFile,
+  _In_opt_ LPCWSTR lpParameters,
+  _In_opt_ LPCWSTR lpDirectory,
+  _In_ INT nShowCmd);
+
+BOOL WINAPI ShellExecuteExA(_Inout_ LPSHELLEXECUTEINFOA);
+BOOL WINAPI ShellExecuteExW(_Inout_ LPSHELLEXECUTEINFOW);
+int WINAPI SHFileOperationA(_Inout_ LPSHFILEOPSTRUCTA);
+int WINAPI SHFileOperationW(_Inout_ LPSHFILEOPSTRUCTW);
+void WINAPI SHFreeNameMappings(_In_opt_ HANDLE);
+
+DWORD_PTR
+WINAPI
+SHGetFileInfoA(
+  _In_ LPCSTR pszPath,
+  DWORD dwFileAttributes,
+  _Inout_updates_bytes_opt_(cbFileInfo) SHFILEINFOA *psfi,
+  UINT cbFileInfo,
+  UINT uFlags);
+
+DWORD_PTR
+WINAPI
+SHGetFileInfoW(
+  _In_ LPCWSTR pszPath,
+  DWORD dwFileAttributes,
+  _Inout_updates_bytes_opt_(cbFileInfo) SHFILEINFOW *psfi,
+  UINT cbFileInfo,
+  UINT uFlags);
+
+_Success_(return != 0)
+BOOL
+WINAPI
+SHGetNewLinkInfoA(
+  _In_ LPCSTR pszLinkTo,
+  _In_ LPCSTR pszDir,
+  _Out_writes_(MAX_PATH) LPSTR pszName,
+  _Out_ BOOL *pfMustCopy,
+  _In_ UINT uFlags);
+
+_Success_(return != 0)
+BOOL
+WINAPI
+SHGetNewLinkInfoW(
+  _In_ LPCWSTR pszLinkTo,
+  _In_ LPCWSTR pszDir,
+  _Out_writes_(MAX_PATH) LPWSTR pszName,
+  _Out_ BOOL *pfMustCopy,
+  _In_ UINT uFlags);
+
+HRESULT
+WINAPI
+SHQueryRecycleBinA(
+  _In_opt_ LPCSTR pszRootPath,
+  _Inout_ LPSHQUERYRBINFO pSHQueryRBInfo);
+
+HRESULT
+WINAPI
+SHQueryRecycleBinW(
+  _In_opt_ LPCWSTR pszRootPath,
+  _Inout_ LPSHQUERYRBINFO pSHQueryRBInfo);
+
+HRESULT
+WINAPI
+SHEmptyRecycleBinA(
+  _In_opt_ HWND hwnd,
+  _In_opt_ LPCSTR pszRootPath,
+  DWORD dwFlags);
+
+HRESULT
+WINAPI
+SHEmptyRecycleBinW(
+  _In_opt_ HWND hwnd,
+  _In_opt_ LPCWSTR pszRootPath,
+  DWORD dwFlags);
+
+BOOL WINAPI SHCreateProcessAsUserW(_Inout_ PSHCREATEPROCESSINFOW);
 
 DWORD
 WINAPI
@@ -444,7 +621,6 @@
 #define ShellMessageBox ShellMessageBoxW
 #define SHFileOperation SHFileOperationW
 #define SHGetFileInfo SHGetFileInfoW
-#define SHGetNewLinkInfo SHGetNewLinkInfoW
 #define SHQueryRecycleBin SHQueryRecycleBinW
 #define SHEmptyRecycleBin SHEmptyRecycleBinW
 #define SHGetNewLinkInfo SHGetNewLinkInfoW
@@ -472,7 +648,6 @@
 #define ShellMessageBox ShellMessageBoxA
 #define SHFileOperation SHFileOperationA
 #define SHGetFileInfo SHGetFileInfoA
-#define SHGetNewLinkInfo SHGetNewLinkInfoA
 #define SHQueryRecycleBin SHQueryRecycleBinA
 #define SHEmptyRecycleBin SHEmptyRecycleBinA
 #define SHGetNewLinkInfo SHGetNewLinkInfoA