ReceiveTempSMS
/
Sweden-Number
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation updates.

This commit is contained in:
Jon Griffiths 2003-03-18 18:35:48 +00:00 committed by Alexandre Julliard
parent 84d1a8ff8c
commit cd4234aa49
32 changed files with 1510 additions and 704 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
dlls/advapi32/advapi.c
View File

@ -38,8 +38,15 @@ WINE_DEFAULT_DEBUG_CHANNEL(advapi);
/****************************************************************************** /******************************************************************************
* GetUserNameA [ADVAPI32.@] * GetUserNameA [ADVAPI32.@]
* *
* NOTE: lpSize returns the total length of the username, including the * Get the current user name.
* terminating null character. *
* PARAMS
* lpszName [O] Destination for the user name.
* lpSize [I/O] Size of lpszName.
*
* RETURNS
* Success: The length of the user name, including terminating NUL.
* Failure: ERROR_MORE_DATA if *lpSize is too small.
*/ */
BOOL WINAPI BOOL WINAPI
GetUserNameA( LPSTR lpszName, LPDWORD lpSize ) GetUserNameA( LPSTR lpszName, LPDWORD lpSize )
@ -64,9 +71,7 @@ GetUserNameA( LPSTR lpszName, LPDWORD lpSize )
/****************************************************************************** /******************************************************************************
* GetUserNameW [ADVAPI32.@] * GetUserNameW [ADVAPI32.@]
* *
* PARAMS * See GetUserNameA.
* lpszName []
* lpSize []
*/ */
BOOL WINAPI BOOL WINAPI
GetUserNameW( LPWSTR lpszName, LPDWORD lpSize ) GetUserNameW( LPWSTR lpszName, LPDWORD lpSize )
@ -88,21 +93,39 @@ GetUserNameW( LPWSTR lpszName, LPDWORD lpSize )
/****************************************************************************** /******************************************************************************
* GetCurrentHwProfileA [ADVAPI32.@] * GetCurrentHwProfileA [ADVAPI32.@]
*
* Get the current hardware profile.
*
* PARAMS
* pInfo [O] Destination for hardware profile information.
*
* RETURNS
* Success: TRUE. pInfo is updated with the hardware profile details.
* Failure: FALSE.
*/ */
BOOL WINAPI GetCurrentHwProfileA(LPHW_PROFILE_INFOA info) BOOL WINAPI GetCurrentHwProfileA(LPHW_PROFILE_INFOA pInfo)
{ {
FIXME("Mostly Stub\n"); FIXME("(%p) semi-stub\n", pInfo);
info->dwDockInfo = DOCKINFO_DOCKED; pInfo->dwDockInfo = DOCKINFO_DOCKED;
strcpy(info->szHwProfileGuid,"{12340001-1234-1234-1234-1233456789012}"); strcpy(pInfo->szHwProfileGuid,"{12340001-1234-1234-1234-1233456789012}");
strcpy(info->szHwProfileName,"Wine Profile"); strcpy(pInfo->szHwProfileName,"Wine Profile");
return 1; return 1;
} }
/****************************************************************************** /******************************************************************************
* AbortSystemShutdownA [ADVAPI32.@] * AbortSystemShutdownA [ADVAPI32.@]
* *
* Stop a system shutdown if one is in progress.
*
* PARAMS * PARAMS
* lpMachineName * lpMachineName [I] Name of machine to not shutdown.
*
* RETURNS
* Success: TRUE.
* Failure: FALSE.
*
* NOTES
* The Wine implementation of this function is a harmless stub.
*/ */
BOOL WINAPI AbortSystemShutdownA( LPSTR lpMachineName ) BOOL WINAPI AbortSystemShutdownA( LPSTR lpMachineName )
{ {
@ -113,8 +136,7 @@ BOOL WINAPI AbortSystemShutdownA( LPSTR lpMachineName )
/****************************************************************************** /******************************************************************************
* AbortSystemShutdownW [ADVAPI32.@] * AbortSystemShutdownW [ADVAPI32.@]
* *
* PARAMS * See AbortSystemShutdownA.
* lpMachineName
*/ */
BOOL WINAPI AbortSystemShutdownW( LPCWSTR lpMachineName ) BOOL WINAPI AbortSystemShutdownW( LPCWSTR lpMachineName )
{ {

17
dlls/advapi32/registry.c
View File

@ -1405,12 +1405,7 @@ DWORD WINAPI RegEnumValueA( HKEY hkey, DWORD index, LPSTR value, LPDWORD val_cou
/****************************************************************************** /******************************************************************************
* RegDeleteValueW [ADVAPI32.@] * RegDeleteValueW [ADVAPI32.@]
* *
* PARAMS * See RegDeleteValueA.
* hkey [I] handle to key
* name [I] name of value to delete
*
* RETURNS
* error status
*/ */
DWORD WINAPI RegDeleteValueW( HKEY hkey, LPCWSTR name ) DWORD WINAPI RegDeleteValueW( HKEY hkey, LPCWSTR name )
{ {
@ -1425,6 +1420,16 @@ DWORD WINAPI RegDeleteValueW( HKEY hkey, LPCWSTR name )
/****************************************************************************** /******************************************************************************
* RegDeleteValueA [ADVAPI32.@] * RegDeleteValueA [ADVAPI32.@]
*
* Delete a value from the registry.
*
* PARAMS
* hkey [I] Registry handle of the key holding the value
* name [I] Name of the value under hkey to delete
*
* RETURNS
* Success: 0
* Failure: A standard Windows error code.
*/ */
DWORD WINAPI RegDeleteValueA( HKEY hkey, LPCSTR name ) DWORD WINAPI RegDeleteValueA( HKEY hkey, LPCSTR name )
{ {

158
dlls/advapi32/security.c
View File

@ -94,14 +94,19 @@ BOOL ADVAPI_IsLocalComputer(LPCWSTR ServerName)
/****************************************************************************** /******************************************************************************
* OpenProcessToken [ADVAPI32.@] * OpenProcessToken [ADVAPI32.@]
* Opens the access token associated with a process * Opens the access token associated with a process handle.
* *
* PARAMS * PARAMS
* ProcessHandle [I] Handle to process * ProcessHandle [I] Handle to process
* DesiredAccess [I] Desired access to process * DesiredAccess [I] Desired access to process
* TokenHandle [O] Pointer to handle of open access token * TokenHandle [O] Pointer to handle of open access token
* *
* RETURNS STD * RETURNS
* Success: TRUE. TokenHandle contains the access token.
* Failure: FALSE.
*
* NOTES
* See NtOpenProcessToken.
*/ */
BOOL WINAPI BOOL WINAPI
OpenProcessToken( HANDLE ProcessHandle, DWORD DesiredAccess, OpenProcessToken( HANDLE ProcessHandle, DWORD DesiredAccess,
@ -113,11 +118,20 @@ OpenProcessToken( HANDLE ProcessHandle, DWORD DesiredAccess,
/****************************************************************************** /******************************************************************************
* OpenThreadToken [ADVAPI32.@] * OpenThreadToken [ADVAPI32.@]
* *
* Opens the access token associated with a thread handle.
*
* PARAMS * PARAMS
* thread [] * ThreadHandle [I] Handle to process
* desiredaccess [] * DesiredAccess [I] Desired access to the thread
* openasself [] * OpenAsSelf [I] ???
* thandle [] * TokenHandle [O] Destination for the token handle
*
* RETURNS
* Success: TRUE. TokenHandle contains the access token.
* Failure: FALSE.
*
* NOTES
* See NtOpenThreadToken.
*/ */
BOOL WINAPI BOOL WINAPI
OpenThreadToken( HANDLE ThreadHandle, DWORD DesiredAccess, OpenThreadToken( HANDLE ThreadHandle, DWORD DesiredAccess,
@ -129,13 +143,23 @@ OpenThreadToken( HANDLE ThreadHandle, DWORD DesiredAccess,
/****************************************************************************** /******************************************************************************
* AdjustTokenPrivileges [ADVAPI32.@] * AdjustTokenPrivileges [ADVAPI32.@]
* *
* Adjust the privileges of an open token handle.
*
* PARAMS * PARAMS
* TokenHandle [] * TokenHandle [I] Handle from OpenProcessToken() or OpenThreadToken()
* DisableAllPrivileges [] * DisableAllPrivileges [I] TRUE=Remove all privileges, FALSE=Use NewState
* NewState [] * NewState [I] Desired new privileges of the token
* BufferLength [] * BufferLength [I] Length of NewState
* PreviousState [] * PreviousState [O] Destination for the previous state
* ReturnLength [] * ReturnLength [I/O] Size of PreviousState
*
*
* RETURNS
* Success: TRUE. Privileges are set to NewState and PreviousState is updated.
* Failure: FALSE.
*
* NOTES
* See NtAdjustPrivilegesToken.
*/ */
BOOL WINAPI BOOL WINAPI
AdjustTokenPrivileges( HANDLE TokenHandle, BOOL DisableAllPrivileges, AdjustTokenPrivileges( HANDLE TokenHandle, BOOL DisableAllPrivileges,
@ -148,10 +172,16 @@ AdjustTokenPrivileges( HANDLE TokenHandle, BOOL DisableAllPrivileges,
/****************************************************************************** /******************************************************************************
* CheckTokenMembership [ADVAPI32.@] * CheckTokenMembership [ADVAPI32.@]
* *
* Determine if an access token is a member of a SID.
*
* PARAMS * PARAMS
* TokenHandle [I] * TokenHandle [I] Handle from OpenProcessToken() or OpenThreadToken()
* SidToCheck [I] * SidToCheck [I] SID that possibly contains the token
* IsMember [O] * IsMember [O] Destination for result.
*
* RETURNS
* Success: TRUE. IsMember is TRUE if TokenHandle is a member, FALSE otherwise.
* Failure: FALSE.
*/ */
BOOL WINAPI BOOL WINAPI
CheckTokenMembership( HANDLE TokenHandle, PSID SidToCheck, CheckTokenMembership( HANDLE TokenHandle, PSID SidToCheck,
@ -167,12 +197,18 @@ CheckTokenMembership( HANDLE TokenHandle, PSID SidToCheck,
* GetTokenInformation [ADVAPI32.@] * GetTokenInformation [ADVAPI32.@]
* *
* PARAMS * PARAMS
* token [I] * token [I] Handle from OpenProcessToken() or OpenThreadToken()
* tokeninfoclass [I] * tokeninfoclass [I] A TOKEN_INFORMATION_CLASS from "winnt.h"
* tokeninfo [O] * tokeninfo [O] Destination for token information
* tokeninfolength [I] * tokeninfolength [I] Length of tokeninfo
* retlen [O] * retlen [O] Destination for returned token information length
* *
* RETURNS
* Success: TRUE. tokeninfo contains retlen bytes of token information
* Failure: FALSE.
*
* NOTES
* See NtQueryInformationToken.
*/ */
BOOL WINAPI BOOL WINAPI
GetTokenInformation( HANDLE token, TOKEN_INFORMATION_CLASS tokeninfoclass, GetTokenInformation( HANDLE token, TOKEN_INFORMATION_CLASS tokeninfoclass,
@ -203,12 +239,17 @@ GetTokenInformation( HANDLE token, TOKEN_INFORMATION_CLASS tokeninfoclass,
/****************************************************************************** /******************************************************************************
* SetTokenInformation [ADVAPI32.@] * SetTokenInformation [ADVAPI32.@]
* *
* PARAMS * Set information for an access token.
* token [I]
* tokeninfoclass [I]
* tokeninfo [I]
* tokeninfolength [I]
* *
* PARAMS
* token [I] Handle from OpenProcessToken() or OpenThreadToken()
* tokeninfoclass [I] A TOKEN_INFORMATION_CLASS from "winnt.h"
* tokeninfo [I] Token information to set
* tokeninfolength [I] Length of tokeninfo
*
* RETURNS
* Success: TRUE. The information for the token is set to tokeninfo.
* Failure: FALSE.
*/ */
BOOL WINAPI BOOL WINAPI
SetTokenInformation( HANDLE token, TOKEN_INFORMATION_CLASS tokeninfoclass, SetTokenInformation( HANDLE token, TOKEN_INFORMATION_CLASS tokeninfoclass,
@ -242,13 +283,22 @@ SetTokenInformation( HANDLE token, TOKEN_INFORMATION_CLASS tokeninfoclass,
/************************************************************************* /*************************************************************************
* SetThreadToken [ADVAPI32.@] * SetThreadToken [ADVAPI32.@]
* *
* Assigns an "impersonation token" to a thread so it can assume the * Assigns an 'impersonation token' to a thread so it can assume the
* security privledges of another thread or process. Can also remove * security privledges of another thread or process. Can also remove
* a previously assigned token. Only supported on NT - it's a stub * a previously assigned token.
* exactly like this one on Win9X.
* *
* PARAMS
* thread [O] Handle to thread to set the token for
* token [I] Token to set
*
* RETURNS
* Success: TRUE. The threads access token is set to token
* Failure: FALSE.
*
* NOTES
* Only supported on NT or higher. On Win9X this function does nothing.
* See SetTokenInformation.
*/ */
BOOL WINAPI SetThreadToken(PHANDLE thread, HANDLE token) BOOL WINAPI SetThreadToken(PHANDLE thread, HANDLE token)
{ {
FIXME("(%p, %p): stub (NT impl. only)\n", thread, token); FIXME("(%p, %p): stub (NT impl. only)\n", thread, token);
@ -608,14 +658,8 @@ DWORD WINAPI InitializeAcl(PACL acl, DWORD size, DWORD rev)
/****************************************************************************** /******************************************************************************
* LookupPrivilegeValueW [ADVAPI32.@] * LookupPrivilegeValueW [ADVAPI32.@]
* Retrieves LUID used on a system to represent the privilege name.
* *
* PARAMS * See LookupPrivilegeValueA.
* lpSystemName [I] Address of string specifying the system
* lpName [I] Address of string specifying the privilege
* lpLuid [I] Address of locally unique identifier
*
* RETURNS STD
*/ */
BOOL WINAPI BOOL WINAPI
LookupPrivilegeValueW( LPCWSTR lpSystemName, LPCWSTR lpName, PLUID lpLuid ) LookupPrivilegeValueW( LPCWSTR lpSystemName, LPCWSTR lpName, PLUID lpLuid )
@ -629,6 +673,17 @@ LookupPrivilegeValueW( LPCWSTR lpSystemName, LPCWSTR lpName, PLUID lpLuid )
/****************************************************************************** /******************************************************************************
* LookupPrivilegeValueA [ADVAPI32.@] * LookupPrivilegeValueA [ADVAPI32.@]
*
* Retrieves LUID used on a system to represent the privilege name.
*
* PARAMS
* lpSystemName [I] Name of the system
* lpName [I] Name of the privilege
* pLuid [O] Destination for the resulting LUD
*
* RETURNS
* Success: TRUE. pLuid contains the requested LUID.
* Failure: FALSE.
*/ */
BOOL WINAPI BOOL WINAPI
LookupPrivilegeValueA( LPCSTR lpSystemName, LPCSTR lpName, PLUID lpLuid ) LookupPrivilegeValueA( LPCSTR lpSystemName, LPCSTR lpName, PLUID lpLuid )
@ -648,9 +703,22 @@ LookupPrivilegeValueA( LPCSTR lpSystemName, LPCSTR lpName, PLUID lpLuid )
/****************************************************************************** /******************************************************************************
* GetFileSecurityA [ADVAPI32.@] * GetFileSecurityA [ADVAPI32.@]
* *
* Obtains Specified information about the security of a file or directory * Obtains Specified information about the security of a file or directory.
* The information obtained is constrained by the callers access rights and *
* privileges * PARAMS
* lpFileName [I] Name of the file to get info for
* RequestedInformation [I] SE_ flags from "winnt.h"
* pSecurityDescriptor [O] Destination for security information
* nLength [I] Length of pSecurityDescriptor
* lpnLengthNeeded [O] Destination for length of returned security information
*
* RETURNS
* Success: TRUE. pSecurityDescriptor contains the requested information.
* Failure: FALSE. lpnLengthNeeded contains the required space to return the info.
*
* NOTES
* The information returned is constrained by the callers access rights and
* privileges.
*/ */
BOOL WINAPI BOOL WINAPI
GetFileSecurityA( LPCSTR lpFileName, GetFileSecurityA( LPCSTR lpFileName,
@ -665,16 +733,7 @@ GetFileSecurityA( LPCSTR lpFileName,
/****************************************************************************** /******************************************************************************
* GetFileSecurityW [ADVAPI32.@] * GetFileSecurityW [ADVAPI32.@]
* *
* Obtains Specified information about the security of a file or directory * See GetFileSecurityA.
* The information obtained is constrained by the callers access rights and
* privileges
*
* PARAMS
* lpFileName []
* RequestedInformation []
* pSecurityDescriptor []
* nLength []
* lpnLengthNeeded []
*/ */
BOOL WINAPI BOOL WINAPI
GetFileSecurityW( LPCWSTR lpFileName, GetFileSecurityW( LPCWSTR lpFileName,
@ -881,6 +940,7 @@ LsaQueryInformationPolicy(
struct di * xdi = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(xdi)); struct di * xdi = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(xdi));
RtlCreateUnicodeStringFromAsciiz(&(xdi->ppdi.Name), "DOMAIN"); RtlCreateUnicodeStringFromAsciiz(&(xdi->ppdi.Name), "DOMAIN");
xdi->ppdi.Sid = &(xdi->sid); xdi->ppdi.Sid = &(xdi->sid);
xdi->sid.Revision = SID_REVISION; xdi->sid.Revision = SID_REVISION;
xdi->sid.SubAuthorityCount = 1; xdi->sid.SubAuthorityCount = 1;

12
dlls/comctl32/comctl32undoc.c
View File

@ -1809,9 +1809,9 @@ DPA_Clone (const HDPA hdpa, const HDPA hdpaNew)
*/ */
LPVOID WINAPI LPVOID WINAPI
DPA_GetPtr (const HDPA hdpa, INT i) DPA_GetPtr (const HDPA hdpa, INT nIndex)
{ {
TRACE("(%p %d)\n", hdpa, i); TRACE("(%p %d)\n", hdpa, nIndex);
if (!hdpa) if (!hdpa)
return NULL; return NULL;
@ -1819,14 +1819,14 @@ DPA_GetPtr (const HDPA hdpa, INT i)
WARN("no pointer array.\n"); WARN("no pointer array.\n");
return NULL; return NULL;
} }
if ((i < 0) || (i >= hdpa->nItemCount)) { if ((nIndex < 0) || (nIndex >= hdpa->nItemCount)) {
WARN("not enough pointers in array (%d vs %d).\n",i,hdpa->nItemCount); WARN("not enough pointers in array (%d vs %d).\n",nIndex,hdpa->nItemCount);
return NULL; return NULL;
} }
TRACE("-- %p\n", hdpa->ptrs[i]); TRACE("-- %p\n", hdpa->ptrs[nIndex]);
return hdpa->ptrs[i]; return hdpa->ptrs[nIndex];
} }

6
dlls/comctl32/commctrl.c
View File

@ -1145,12 +1145,12 @@ BOOL WINAPI SetWindowSubclass (HWND hWnd, SUBCLASSPROC pfnSubclass,
* PARAMS * PARAMS
* hWnd [in] Handle to window which were subclassing * hWnd [in] Handle to window which were subclassing
* pfnSubclass [in] Pointer to the subclass procedure * pfnSubclass [in] Pointer to the subclass procedure
* iID [in] Unique indentifier of the subclassing procedure * uID [in] Unique indentifier of the subclassing procedure
* pdwRef [out] Pointer to the reference data * pdwRef [out] Pointer to the reference data
* *
* RETURNS * RETURNS
* Success: non-sero * Success: Non-zero
* Failure: zero * Failure: 0
*/ */
BOOL WINAPI GetWindowSubclass (HWND hWnd, SUBCLASSPROC pfnSubclass, BOOL WINAPI GetWindowSubclass (HWND hWnd, SUBCLASSPROC pfnSubclass,

94
dlls/kernel/thunk.c
View File

@ -759,34 +759,34 @@ void WINAPI OT_32ThkLSF( CONTEXT86 *context )
* A thunk setup routine. * A thunk setup routine.
* Expects a pointer to a preinitialized thunkbuffer in the first argument * Expects a pointer to a preinitialized thunkbuffer in the first argument
* looking like: * looking like:
* 00..03: unknown (pointer, check _41, _43, _46) *| 00..03: unknown (pointer, check _41, _43, _46)
* 04: EB1E jmp +0x20 *| 04: EB1E jmp +0x20
* *|
* 06..23: unknown (space for replacement code, check .90) *| 06..23: unknown (space for replacement code, check .90)
* *|
* 24:>E800000000 call offset 29 *| 24:>E800000000 call offset 29
* 29:>58 pop eax ( target of call ) *| 29:>58 pop eax ( target of call )
* 2A: 2D25000000 sub eax,0x00000025 ( now points to offset 4 ) *| 2A: 2D25000000 sub eax,0x00000025 ( now points to offset 4 )
* 2F: BAxxxxxxxx mov edx,xxxxxxxx *| 2F: BAxxxxxxxx mov edx,xxxxxxxx
* 34: 68yyyyyyyy push KERNEL32.90 *| 34: 68yyyyyyyy push KERNEL32.90
* 39: C3 ret *| 39: C3 ret
* *|
* 3A: EB1E jmp +0x20 *| 3A: EB1E jmp +0x20
* 3E ... 59: unknown (space for replacement code?) *| 3E ... 59: unknown (space for replacement code?)
* 5A: E8xxxxxxxx call <32bitoffset xxxxxxxx> *| 5A: E8xxxxxxxx call <32bitoffset xxxxxxxx>
* 5F: 5A pop edx *| 5F: 5A pop edx
* 60: 81EA25xxxxxx sub edx, 0x25xxxxxx *| 60: 81EA25xxxxxx sub edx, 0x25xxxxxx
* 66: 52 push edx *| 66: 52 push edx
* 67: 68xxxxxxxx push xxxxxxxx *| 67: 68xxxxxxxx push xxxxxxxx
* 6C: 68yyyyyyyy push KERNEL32.89 *| 6C: 68yyyyyyyy push KERNEL32.89
* 71: C3 ret *| 71: C3 ret
* 72: end? *| 72: end?
* This function checks if the code is there, and replaces the yyyyyyyy entries * This function checks if the code is there, and replaces the yyyyyyyy entries
* by the functionpointers. * by the functionpointers.
* The thunkbuf looks like: * The thunkbuf looks like:
* *
* 00: DWORD length ? don't know exactly *| 00: DWORD length ? don't know exactly
* 04: SEGPTR ptr ? where does it point to? *| 04: SEGPTR ptr ? where does it point to?
* The segpointer ptr is written into the first DWORD of 'thunk'. * The segpointer ptr is written into the first DWORD of 'thunk'.
* [ok probably] * [ok probably]
* RETURNS * RETURNS
@ -1020,17 +1020,18 @@ void WINAPI W32S_BackTo32( CONTEXT86 *context )
/********************************************************************** /**********************************************************************
* AllocSLCallback (KERNEL32.@) * AllocSLCallback (KERNEL32.@)
* *
* NOTES
* Win95 uses some structchains for callbacks. It allocates them * Win95 uses some structchains for callbacks. It allocates them
* in blocks of 100 entries, size 32 bytes each, layout: * in blocks of 100 entries, size 32 bytes each, layout:
* blockstart: * blockstart:
* 0: PTR nextblockstart *| 0: PTR nextblockstart
* 4: entry *first; *| 4: entry *first;
* 8: WORD sel ( start points to blockstart) *| 8: WORD sel ( start points to blockstart)
* A: WORD unknown *| A: WORD unknown
* 100xentry: * 100xentry:
* 00..17: Code *| 00..17: Code
* 18: PDB *owning_process; *| 18: PDB *owning_process;
* 1C: PTR blockstart *| 1C: PTR blockstart
* *
* We ignore this for now. (Just a note for further developers) * We ignore this for now. (Just a note for further developers)
* FIXME: use this method, so we don't waste selectors... * FIXME: use this method, so we don't waste selectors...
@ -1038,21 +1039,21 @@ void WINAPI W32S_BackTo32( CONTEXT86 *context )
* Following code is then generated by AllocSLCallback. The code is 16 bit, so * Following code is then generated by AllocSLCallback. The code is 16 bit, so
* the 0x66 prefix switches from word->long registers. * the 0x66 prefix switches from word->long registers.
* *
* 665A pop edx *| 665A pop edx
* 6668x arg2 x pushl <arg2> *| 6668x arg2 x pushl <arg2>
* 6652 push edx *| 6652 push edx
* EAx arg1 x jmpf <arg1> *| EAx arg1 x jmpf <arg1>
* *
* returns the startaddress of this thunk. * returns the startaddress of this thunk.
* *
* Note, that they look very similair to the ones allocates by THUNK_Alloc. * Note, that they look very similar to the ones allocates by THUNK_Alloc.
* RETURNS * RETURNS
* segmented pointer to the start of the thunk * A segmented pointer to the start of the thunk
*/ */
DWORD WINAPI DWORD WINAPI
AllocSLCallback( AllocSLCallback(
DWORD finalizer, /* [in] finalizer function */ DWORD finalizer, /* [in] Finalizer function */
DWORD callback /* [in] callback function */ DWORD callback /* [in] Callback function */
) { ) {
LPBYTE x,thunk = HeapAlloc( GetProcessHeap(), 0, 32 ); LPBYTE x,thunk = HeapAlloc( GetProcessHeap(), 0, 32 );
WORD sel; WORD sel;
@ -1092,15 +1093,20 @@ void WINAPI GetTEBSelectorFS16(void)
/********************************************************************** /**********************************************************************
* IsPeFormat (KERNEL.431) * IsPeFormat (KERNEL.431)
* Checks the passed filename if it is a PE format executeable *
* Determine if a file is a PE format executable.
*
* RETURNS * RETURNS
* TRUE, if it is. * TRUE, if it is.
* FALSE if not. * FALSE if the file could not be opened or is not a PE file.
*
* NOTES
* If fn is given as NULL then the function expects hf16 to be valid.
*/ */
BOOL16 WINAPI IsPeFormat16( BOOL16 WINAPI IsPeFormat16(
LPSTR fn, /* [in] filename to executeable */ LPSTR fn, /* [in] Filename to the executeable */
HFILE16 hf16 /* [in] open file, if filename is NULL */ HFILE16 hf16) /* [in] An open file handle */
) { {
BOOL ret = FALSE; BOOL ret = FALSE;
IMAGE_DOS_HEADER mzh; IMAGE_DOS_HEADER mzh;
OFSTRUCT ofs; OFSTRUCT ofs;

103
dlls/kernel/time.c
View File

@ -51,13 +51,13 @@ WINE_DEFAULT_DEBUG_CHANNEL(win32);
/*********************************************************************** /***********************************************************************
* SetLocalTime (KERNEL32.@) * SetLocalTime (KERNEL32.@)
* *
* Sets the local time using current time zone and daylight * Set the local time using current time zone and daylight
* savings settings. * savings settings.
* *
* RETURNS * RETURNS
* * Success: TRUE. The time was set
* True if the time was set, false if the time was invalid or the * Failure: FALSE, if the time was invalid or caller does not have
* necessary permissions were not held. * permission to change the time.
*/ */
BOOL WINAPI SetLocalTime( BOOL WINAPI SetLocalTime(
const SYSTEMTIME *systime) /* [in] The desired local time. */ const SYSTEMTIME *systime) /* [in] The desired local time. */
@ -80,15 +80,13 @@ BOOL WINAPI SetLocalTime(
/*********************************************************************** /***********************************************************************
* GetSystemTimeAdjustment (KERNEL32.@) * GetSystemTimeAdjustment (KERNEL32.@)
* *
* Indicates the period between clock interrupt and the amount the clock * Get the period between clock interrupts and the amount the clock
* is adjusted each interrupt so as to keep it insync with an external source. * is adjusted each interrupt so as to keep it in sync with an external source.
* *
* RETURNS * RETURNS
* * TRUE.
* Always returns true.
* *
* BUGS * BUGS
*
* Only the special case of disabled time adjustments is supported. * Only the special case of disabled time adjustments is supported.
*/ */
BOOL WINAPI GetSystemTimeAdjustment( BOOL WINAPI GetSystemTimeAdjustment(
@ -106,12 +104,12 @@ BOOL WINAPI GetSystemTimeAdjustment(
/*********************************************************************** /***********************************************************************
* SetSystemTime (KERNEL32.@) * SetSystemTime (KERNEL32.@)
* *
* Sets the system time (utc). * Set the system time in utc.
* *
* RETURNS * RETURNS
* * Success: TRUE. The time was set
* True if the time was set, false if the time was invalid or the * Failure: FALSE, if the time was invalid or caller does not have
* necessary permissions were not held. * permission to change the time.
*/ */
BOOL WINAPI SetSystemTime( BOOL WINAPI SetSystemTime(
const SYSTEMTIME *systime) /* [in] The desired system time. */ const SYSTEMTIME *systime) /* [in] The desired system time. */
@ -132,15 +130,14 @@ BOOL WINAPI SetSystemTime(
/*********************************************************************** /***********************************************************************
* GetTimeZoneInformation (KERNEL32.@) * GetTimeZoneInformation (KERNEL32.@)
* *
* Fills in the a time zone information structure with values based on * Get information about the current local time zone.
* the current local time.
* *
* RETURNS * RETURNS
* * Success: TIME_ZONE_ID_STANDARD. tzinfo contains the time zone info.
* The daylight savings time standard or TIME_ZONE_ID_INVALID if the call failed. * Failure: TIME_ZONE_ID_INVALID.
*/ */
DWORD WINAPI GetTimeZoneInformation( DWORD WINAPI GetTimeZoneInformation(
LPTIME_ZONE_INFORMATION tzinfo) /* [out] The time zone structure to be filled in. */ LPTIME_ZONE_INFORMATION tzinfo) /* [out] Destination for time zone information */
{ {
NTSTATUS status; NTSTATUS status;
if ((status = RtlQueryTimeZoneInformation(tzinfo))) if ((status = RtlQueryTimeZoneInformation(tzinfo)))
@ -152,11 +149,11 @@ DWORD WINAPI GetTimeZoneInformation(
/*********************************************************************** /***********************************************************************
* SetTimeZoneInformation (KERNEL32.@) * SetTimeZoneInformation (KERNEL32.@)
* *
* Set the local time zone with values based on the time zone structure. * Change the settings of the current local time zone.
* *
* RETURNS * RETURNS
* * Success: TRUE. The time zone was updated with the settings from tzinfo
* True on successful setting of the time zone. * Failure: FALSE.
*/ */
BOOL WINAPI SetTimeZoneInformation( BOOL WINAPI SetTimeZoneInformation(
const LPTIME_ZONE_INFORMATION tzinfo) /* [in] The new time zone. */ const LPTIME_ZONE_INFORMATION tzinfo) /* [in] The new time zone. */
@ -346,12 +343,11 @@ static BOOL _GetTimezoneBias(
/*********************************************************************** /***********************************************************************
* SystemTimeToTzSpecificLocalTime (KERNEL32.@) * SystemTimeToTzSpecificLocalTime (KERNEL32.@)
* *
* Converts the system time (utc) to the local time in the specified time zone. * Convert a utc system time to a local time in a given time zone.
* *
* RETURNS * RETURNS
* * Success: TRUE. lpLocalTime contains the converted time
* Returns TRUE when the local time was calculated. * Failure: FALSE.
*
*/ */
BOOL WINAPI SystemTimeToTzSpecificLocalTime( BOOL WINAPI SystemTimeToTzSpecificLocalTime(
@ -397,13 +393,12 @@ BOOL WINAPI SystemTimeToTzSpecificLocalTime(
/*********************************************************************** /***********************************************************************
* TzSpecificLocalTimeToSystemTime (KERNEL32.@) * TzSpecificLocalTimeToSystemTime (KERNEL32.@)
* *
* Converts a local time to a time in Coordinated Universal Time (UTC). * Converts a local time to a time in utc.
* *
* RETURNS * RETURNS
* * Success: TRUE. lpUniversalTime contains the converted time
* Returns TRUE when the utc time was calculated. * Failure: FALSE.
*/ */
BOOL WINAPI TzSpecificLocalTimeToSystemTime( BOOL WINAPI TzSpecificLocalTimeToSystemTime(
LPTIME_ZONE_INFORMATION lpTimeZoneInformation, /* [in] The desired time zone. */ LPTIME_ZONE_INFORMATION lpTimeZoneInformation, /* [in] The desired time zone. */
LPSYSTEMTIME lpLocalTime, /* [in] The local time. */ LPSYSTEMTIME lpLocalTime, /* [in] The local time. */
@ -444,15 +439,16 @@ BOOL WINAPI TzSpecificLocalTimeToSystemTime(
} }
/*********************************************************************** /***********************************************************************
* GetSystemTimeAsFileTime (KERNEL32.@) * GetSystemTimeAsFileTime (KERNEL32.@)
* *
* Fills in a file time structure with the current time in UTC format. * Get the current time in utc format.
*
* RETURNS
* Nothing.
*/ */
VOID WINAPI GetSystemTimeAsFileTime( VOID WINAPI GetSystemTimeAsFileTime(
LPFILETIME time) /* [out] The file time struct to be filled with the system time. */ LPFILETIME time) /* [out] Destination for the current utc time */
{ {
LARGE_INTEGER t; LARGE_INTEGER t;
NtQuerySystemTime( &t ); NtQuerySystemTime( &t );
@ -482,20 +478,19 @@ static void TIME_ClockTimeToFileTime(clock_t unix_time, LPFILETIME filetime)
/********************************************************************* /*********************************************************************
* GetProcessTimes (KERNEL32.@) * GetProcessTimes (KERNEL32.@)
* *
* Returns the user and kernel execution times of a process, * Get the user and kernel execution times of a process,
* along with the creation and exit times if known. * along with the creation and exit times if known.
* *
* RETURNS
* TRUE.
*
* NOTES
* olorin@fandra.org: * olorin@fandra.org:
* Would be nice to subtract the cpu time, used by Wine at startup. * Would be nice to subtract the cpu time used by Wine at startup.
* Also, there is a need to separate times used by different applications. * Also, there is a need to separate times used by different applications.
* *
* RETURNS
*
* Always returns true.
*
* BUGS * BUGS
* * lpCreationTime and lpExitTime are not initialised in the Wine implementation.
* lpCreationTime, lpExitTime are NOT INITIALIZED.
*/ */
BOOL WINAPI GetProcessTimes( BOOL WINAPI GetProcessTimes(
HANDLE hprocess, /* [in] The process to be queried (obtained from PROCESS_QUERY_INFORMATION). */ HANDLE hprocess, /* [in] The process to be queried (obtained from PROCESS_QUERY_INFORMATION). */
@ -541,6 +536,7 @@ int WINAPI GetCalendarInfoA(LCID Locale, CALID Calendar, CALTYPE CalType,
/********************************************************************* /*********************************************************************
* GetCalendarInfoW (KERNEL32.@) * GetCalendarInfoW (KERNEL32.@)
* *
* See GetCalendarInfoA.
*/ */
int WINAPI GetCalendarInfoW(LCID Locale, CALID Calendar, CALTYPE CalType, int WINAPI GetCalendarInfoW(LCID Locale, CALID Calendar, CALTYPE CalType,
LPWSTR lpCalData, int cchData, LPDWORD lpValue) LPWSTR lpCalData, int cchData, LPDWORD lpValue)
@ -687,6 +683,7 @@ int WINAPI SetCalendarInfoA(LCID Locale, CALID Calendar, CALTYPE CalType, LPCSTR
/********************************************************************* /*********************************************************************
* SetCalendarInfoW (KERNEL32.@) * SetCalendarInfoW (KERNEL32.@)
* *
* See SetCalendarInfoA.
*/ */
int WINAPI SetCalendarInfoW(LCID Locale, CALID Calendar, CALTYPE CalType, LPCWSTR lpCalData) int WINAPI SetCalendarInfoW(LCID Locale, CALID Calendar, CALTYPE CalType, LPCWSTR lpCalData)
{ {
@ -782,6 +779,16 @@ BOOL WINAPI SystemTimeToFileTime( const SYSTEMTIME *syst, LPFILETIME ft )
/********************************************************************* /*********************************************************************
* CompareFileTime (KERNEL32.@) * CompareFileTime (KERNEL32.@)
*
* Compare two FILETIME's to each other.
*
* PARAMS
* x [I] First time
* y [I] time to compare to x
*
* RETURNS
* -1, 0, or 1 indicating that x is less than, equal to, or greater
* than y respectively.
*/ */
INT WINAPI CompareFileTime( const FILETIME *x, const FILETIME *y ) INT WINAPI CompareFileTime( const FILETIME *x, const FILETIME *y )
{ {
@ -800,8 +807,13 @@ INT WINAPI CompareFileTime( const FILETIME *x, const FILETIME *y )
/********************************************************************* /*********************************************************************
* GetLocalTime (KERNEL32.@) * GetLocalTime (KERNEL32.@)
*
* Get the current local time.
*
* RETURNS
* Nothing.
*/ */
VOID WINAPI GetLocalTime(LPSYSTEMTIME systime) VOID WINAPI GetLocalTime(LPSYSTEMTIME systime) /* [O] Destination for current time */
{ {
FILETIME lft; FILETIME lft;
LARGE_INTEGER ft, ft2; LARGE_INTEGER ft, ft2;
@ -815,8 +827,13 @@ VOID WINAPI GetLocalTime(LPSYSTEMTIME systime)
/********************************************************************* /*********************************************************************
* GetSystemTime (KERNEL32.@) * GetSystemTime (KERNEL32.@)
*
* Get the current system time.
*
* RETURNS
* Nothing.
*/ */
VOID WINAPI GetSystemTime(LPSYSTEMTIME systime) VOID WINAPI GetSystemTime(LPSYSTEMTIME systime) /* [O] Destination for current time */
{ {
FILETIME ft; FILETIME ft;
LARGE_INTEGER t; LARGE_INTEGER t;

65
dlls/ntdll/critsection.c
View File

@ -62,6 +62,14 @@ static inline HANDLE get_semaphore( RTL_CRITICAL_SECTION *crit )
/*********************************************************************** /***********************************************************************
* RtlInitializeCriticalSection (NTDLL.@) * RtlInitializeCriticalSection (NTDLL.@)
*
* Initialise a new RTL_CRITICAL_SECTION.
*
* PARAMS
* crit [O] Critical section to initialise
*
* RETURN
* STATUS_SUCCESS.
*/ */
NTSTATUS WINAPI RtlInitializeCriticalSection( RTL_CRITICAL_SECTION *crit ) NTSTATUS WINAPI RtlInitializeCriticalSection( RTL_CRITICAL_SECTION *crit )
{ {
@ -75,7 +83,18 @@ NTSTATUS WINAPI RtlInitializeCriticalSection( RTL_CRITICAL_SECTION *crit )
/*********************************************************************** /***********************************************************************
* RtlInitializeCriticalSectionAndSpinCount (NTDLL.@) * RtlInitializeCriticalSectionAndSpinCount (NTDLL.@)
* The InitializeCriticalSectionAndSpinCount (KERNEL32) function is *
* Initialise a new RTL_CRITICAL_SECTION with a given spin count.
*
* PARAMS
* crit [O] Critical section to initialise
* spincount [I] Spin count for crit
*
* RETURNS
* STATUS_SUCCESS.
*
* NOTES
* The InitializeCriticalSectionAndSpinCount() (KERNEL32) function is
* available on NT4SP3 or later, and Win98 or later. * available on NT4SP3 or later, and Win98 or later.
* I am assuming that this is the correct definition given the MSDN * I am assuming that this is the correct definition given the MSDN
* docs for the kernel32 functions. * docs for the kernel32 functions.
@ -90,6 +109,14 @@ NTSTATUS WINAPI RtlInitializeCriticalSectionAndSpinCount( RTL_CRITICAL_SECTION *
/*********************************************************************** /***********************************************************************
* RtlDeleteCriticalSection (NTDLL.@) * RtlDeleteCriticalSection (NTDLL.@)
*
* Free the resources used by an RTL_CRITICAL_SECTION.
*
* PARAMS
* crit [I/O] Critical section to free
*
* RETURNS
* STATUS_SUCCESS.
*/ */
NTSTATUS WINAPI RtlDeleteCriticalSection( RTL_CRITICAL_SECTION *crit ) NTSTATUS WINAPI RtlDeleteCriticalSection( RTL_CRITICAL_SECTION *crit )
{ {
@ -104,6 +131,14 @@ NTSTATUS WINAPI RtlDeleteCriticalSection( RTL_CRITICAL_SECTION *crit )
/*********************************************************************** /***********************************************************************
* RtlpWaitForCriticalSection (NTDLL.@) * RtlpWaitForCriticalSection (NTDLL.@)
*
* Wait for an RTL_CRITICAL_SECTION to become free.
*
* PARAMS
* crit [I/O] Critical section to wait for
*
* RETURNS
* STATUS_SUCCESS.
*/ */
NTSTATUS WINAPI RtlpWaitForCriticalSection( RTL_CRITICAL_SECTION *crit ) NTSTATUS WINAPI RtlpWaitForCriticalSection( RTL_CRITICAL_SECTION *crit )
{ {
@ -157,6 +192,17 @@ NTSTATUS WINAPI RtlpUnWaitCriticalSection( RTL_CRITICAL_SECTION *crit )
/*********************************************************************** /***********************************************************************
* RtlEnterCriticalSection (NTDLL.@) * RtlEnterCriticalSection (NTDLL.@)
*
* Enter an RTL_CRITICAL_SECTION.
*
* PARAMS
* crit [I/O] Critical section to enter
*
* RETURNS
* STATUS_SUCCESS. The critical section is held by the caller.
*
* NOTES
* The caller will wait until the critical section is availale.
*/ */
NTSTATUS WINAPI RtlEnterCriticalSection( RTL_CRITICAL_SECTION *crit ) NTSTATUS WINAPI RtlEnterCriticalSection( RTL_CRITICAL_SECTION *crit )
{ {
@ -179,6 +225,15 @@ NTSTATUS WINAPI RtlEnterCriticalSection( RTL_CRITICAL_SECTION *crit )
/*********************************************************************** /***********************************************************************
* RtlTryEnterCriticalSection (NTDLL.@) * RtlTryEnterCriticalSection (NTDLL.@)
*
* Enter an RTL_CRITICAL_SECTION without waiting.
*
* PARAMS
* crit [I/O] Critical section to enter
*
* RETURNS
* Success: TRUE. The critical section is held by the caller.
* Failure: FALSE. The critical section is currently held by another thread.
*/ */
BOOL WINAPI RtlTryEnterCriticalSection( RTL_CRITICAL_SECTION *crit ) BOOL WINAPI RtlTryEnterCriticalSection( RTL_CRITICAL_SECTION *crit )
{ {
@ -201,6 +256,14 @@ BOOL WINAPI RtlTryEnterCriticalSection( RTL_CRITICAL_SECTION *crit )
/*********************************************************************** /***********************************************************************
* RtlLeaveCriticalSection (NTDLL.@) * RtlLeaveCriticalSection (NTDLL.@)
*
* Leave an RTL_CRITICAL_SECTION.
*
* PARAMS
* crit [I/O] Critical section to enter
*
* RETURNS
* STATUS_SUCCESS.
*/ */
NTSTATUS WINAPI RtlLeaveCriticalSection( RTL_CRITICAL_SECTION *crit ) NTSTATUS WINAPI RtlLeaveCriticalSection( RTL_CRITICAL_SECTION *crit )
{ {

134
dlls/ntdll/heap.c
View File

@ -934,6 +934,20 @@ static BOOL HEAP_IsRealArena( HEAP *heapPtr, /* [in] ptr to the heap */
/*********************************************************************** /***********************************************************************
* RtlCreateHeap (NTDLL.@) * RtlCreateHeap (NTDLL.@)
*
* Create a new Heap.
*
* PARAMS
* flags [I] HEAP_ flags from "winnt.h"
* addr [I] Desired base address
* totalSize [I] Total size of the heap, or 0 for a growable heap
* commitSize [I] Amount of heap space to commit
* unknown [I] Not yet understood
* definition [I] Heap definition
*
* RETURNS
* Success: A HANDLE to the newly created heap.
* Failure: a NULL HANDLE.
*/ */
HANDLE WINAPI RtlCreateHeap( ULONG flags, PVOID addr, ULONG totalSize, ULONG commitSize, HANDLE WINAPI RtlCreateHeap( ULONG flags, PVOID addr, ULONG totalSize, ULONG commitSize,
PVOID unknown, PRTL_HEAP_DEFINITION definition ) PVOID unknown, PRTL_HEAP_DEFINITION definition )
@ -969,6 +983,15 @@ HANDLE WINAPI RtlCreateHeap( ULONG flags, PVOID addr, ULONG totalSize, ULONG com
/*********************************************************************** /***********************************************************************
* RtlDestroyHeap (NTDLL.@) * RtlDestroyHeap (NTDLL.@)
*
* Destroy a Heap created with RtlCreateHeap().
*
* PARAMS
* heap [I] Heap to destroy.
*
* RETURNS
* Success: A NULL HANDLE, if heap is NULL or it was destroyed
* Failure: The Heap handle, if heap is the process heap.
*/ */
HANDLE WINAPI RtlDestroyHeap( HANDLE heap ) HANDLE WINAPI RtlDestroyHeap( HANDLE heap )
{ {
@ -1006,7 +1029,19 @@ HANDLE WINAPI RtlDestroyHeap( HANDLE heap )
/*********************************************************************** /***********************************************************************
* RtlAllocateHeap (NTDLL.@) * RtlAllocateHeap (NTDLL.@)
* *
* NOTE: does not set last error. * Allocate a memory block from a Heap.
*
* PARAMS
* heap [I] Heap to allocate block from
* flags [I] HEAP_ flags from "winnt.h"
* size [I] Size of the memory block to allocate
*
* RETURNS
* Success: A pointer to the newly allocated block
* Failure: NULL.
*
* NOTES
* This call does not SetLastError().
*/ */
PVOID WINAPI RtlAllocateHeap( HANDLE heap, ULONG flags, ULONG size ) PVOID WINAPI RtlAllocateHeap( HANDLE heap, ULONG flags, ULONG size )
{ {
@ -1068,6 +1103,17 @@ PVOID WINAPI RtlAllocateHeap( HANDLE heap, ULONG flags, ULONG size )
/*********************************************************************** /***********************************************************************
* RtlFreeHeap (NTDLL.@) * RtlFreeHeap (NTDLL.@)
*
* Free a memory block allocated with RtlAllocateHeap().
*
* PARAMS
* heap [I] Heap that block was allocated from
* flags [I] HEAP_ flags from "winnt.h"
* ptr [I] Block to free
*
* RETURNS
* Success: TRUE, if ptr is NULL or was freed successfully.
* Failure: FALSE.
*/ */
BOOLEAN WINAPI RtlFreeHeap( HANDLE heap, ULONG flags, PVOID ptr ) BOOLEAN WINAPI RtlFreeHeap( HANDLE heap, ULONG flags, PVOID ptr )
{ {
@ -1112,6 +1158,18 @@ BOOLEAN WINAPI RtlFreeHeap( HANDLE heap, ULONG flags, PVOID ptr )
/*********************************************************************** /***********************************************************************
* RtlReAllocateHeap (NTDLL.@) * RtlReAllocateHeap (NTDLL.@)
*
* Change the size of a memory block allocated with RtlAllocateHeap().
*
* PARAMS
* heap [I] Heap that block was allocated from
* flags [I] HEAP_ flags from "winnt.h"
* ptr [I] Block to resize
* size [I] Size of the memory block to allocate
*
* RETURNS
* Success: A pointer to the resized block (which may be different).
* Failure: NULL.
*/ */
PVOID WINAPI RtlReAllocateHeap( HANDLE heap, ULONG flags, PVOID ptr, ULONG size ) PVOID WINAPI RtlReAllocateHeap( HANDLE heap, ULONG flags, PVOID ptr, ULONG size )
{ {
@ -1231,6 +1289,18 @@ PVOID WINAPI RtlReAllocateHeap( HANDLE heap, ULONG flags, PVOID ptr, ULONG size
/*********************************************************************** /***********************************************************************
* RtlCompactHeap (NTDLL.@) * RtlCompactHeap (NTDLL.@)
*
* Compact the free space in a Heap.
*
* PARAMS
* heap [I] Heap that block was allocated from
* flags [I] HEAP_ flags from "winnt.h"
*
* RETURNS
* The number of bytes compacted.
*
* NOTES
* This function is a harmless stub.
*/ */
ULONG WINAPI RtlCompactHeap( HANDLE heap, ULONG flags ) ULONG WINAPI RtlCompactHeap( HANDLE heap, ULONG flags )
{ {
@ -1241,6 +1311,15 @@ ULONG WINAPI RtlCompactHeap( HANDLE heap, ULONG flags )
/*********************************************************************** /***********************************************************************
* RtlLockHeap (NTDLL.@) * RtlLockHeap (NTDLL.@)
*
* Lock a Heap.
*
* PARAMS
* heap [I] Heap to lock
*
* RETURNS
* Success: TRUE. The Heap is locked.
* Failure: FALSE, if heap is invalid.
*/ */
BOOLEAN WINAPI RtlLockHeap( HANDLE heap ) BOOLEAN WINAPI RtlLockHeap( HANDLE heap )
{ {
@ -1253,6 +1332,15 @@ BOOLEAN WINAPI RtlLockHeap( HANDLE heap )
/*********************************************************************** /***********************************************************************
* RtlUnlockHeap (NTDLL.@) * RtlUnlockHeap (NTDLL.@)
*
* Unlock a Heap.
*
* PARAMS
* heap [I] Heap to unlock
*
* RETURNS
* Success: TRUE. The Heap is unlocked.
* Failure: FALSE, if heap is invalid.
*/ */
BOOLEAN WINAPI RtlUnlockHeap( HANDLE heap ) BOOLEAN WINAPI RtlUnlockHeap( HANDLE heap )
{ {
@ -1265,6 +1353,20 @@ BOOLEAN WINAPI RtlUnlockHeap( HANDLE heap )
/*********************************************************************** /***********************************************************************
* RtlSizeHeap (NTDLL.@) * RtlSizeHeap (NTDLL.@)
*
* Get the actual size of a memory block allocated from a Heap.
*
* PARAMS
* heap [I] Heap that block was allocated from
* flags [I] HEAP_ flags from "winnt.h"
* ptr [I] Block to get the size of
*
* RETURNS
* Success: The size of the block.
* Failure: -1, heap or ptr are invalid.
*
* NOTES
* The size may be bigger than what was passed to RtlAllocateHeap().
*/ */
ULONG WINAPI RtlSizeHeap( HANDLE heap, ULONG flags, PVOID ptr ) ULONG WINAPI RtlSizeHeap( HANDLE heap, ULONG flags, PVOID ptr )
{ {
@ -1299,20 +1401,32 @@ ULONG WINAPI RtlSizeHeap( HANDLE heap, ULONG flags, PVOID ptr )
/*********************************************************************** /***********************************************************************
* RtlValidateHeap (NTDLL.@) * RtlValidateHeap (NTDLL.@)
*
* Determine if a block is a valid alloction from a heap.
*
* PARAMS
* heap [I] Heap that block was allocated from
* flags [I] HEAP_ flags from "winnt.h"
* ptr [I] Block to check
*
* RETURNS
* Success: TRUE. The block was allocated from heap.
* Failure: FALSE, if heap is invalid or ptr was not allocated from it.
*/ */
BOOLEAN WINAPI RtlValidateHeap( HANDLE heap, ULONG flags, LPCVOID block ) BOOLEAN WINAPI RtlValidateHeap( HANDLE heap, ULONG flags, LPCVOID ptr )
{ {
HEAP *heapPtr = HEAP_GetPtr( heap ); HEAP *heapPtr = HEAP_GetPtr( heap );
if (!heapPtr) return FALSE; if (!heapPtr) return FALSE;
return HEAP_IsRealArena( heapPtr, flags, block, QUIET ); return HEAP_IsRealArena( heapPtr, flags, ptr, QUIET );
} }
/*********************************************************************** /***********************************************************************
* RtlWalkHeap (NTDLL.@) * RtlWalkHeap (NTDLL.@)
* *
* FIXME: the PROCESS_HEAP_ENTRY flag values seem different between this * FIXME
* function and HeapWalk. To be checked. * The PROCESS_HEAP_ENTRY flag values seem different between this
* function and HeapWalk(). To be checked.
*/ */
NTSTATUS WINAPI RtlWalkHeap( HANDLE heap, PVOID entry_ptr ) NTSTATUS WINAPI RtlWalkHeap( HANDLE heap, PVOID entry_ptr )
{ {
@ -1422,6 +1536,16 @@ HW_end:
/*********************************************************************** /***********************************************************************
* RtlGetProcessHeaps (NTDLL.@) * RtlGetProcessHeaps (NTDLL.@)
*
* Get the Heaps belonging to the current process.
*
* PARAMS
* count [I] size of heaps
* heaps [O] Destination array for heap HANDLE's
*
* RETURNS
* Success: The number of Heaps allocated by the process.
* Failure: 0.
*/ */
ULONG WINAPI RtlGetProcessHeaps( ULONG count, HANDLE *heaps ) ULONG WINAPI RtlGetProcessHeaps( ULONG count, HANDLE *heaps )
{ {

61
dlls/ntdll/om.c
View File

@ -62,14 +62,14 @@ NTSTATUS WINAPI NtQueryObject(
/****************************************************************************** /******************************************************************************
* NtQuerySecurityObject [NTDLL.@] * NtQuerySecurityObject [NTDLL.@]
* *
* analogue to GetKernelObjectSecurity * An ntdll analogue to GetKernelObjectSecurity().
* *
* NOTES * NOTES
* only the lowest 4 bit of SecurityObjectInformationClass are used * only the lowest 4 bit of SecurityObjectInformationClass are used
* 0x7-0xf returns STATUS_ACCESS_DENIED (even running with system privileges) * 0x7-0xf returns STATUS_ACCESS_DENIED (even running with system privileges)
* *
* FIXME: we are constructing a fake sid * FIXME
* (Administrators:Full, System:Full, Everyone:Read) * We are constructing a fake sid (Administrators:Full, System:Full, Everyone:Read)
*/ */
NTSTATUS WINAPI NTSTATUS WINAPI
NtQuerySecurityObject( NtQuerySecurityObject(
@ -245,9 +245,15 @@ NTSTATUS WINAPI NtDuplicateObject( HANDLE source_process, HANDLE source,
/************************************************************************** /**************************************************************************
* NtClose [NTDLL.@] * NtClose [NTDLL.@]
* FUNCTION: Closes a handle reference to an object *
* ARGUMENTS: * Close a handle reference to an object.
* Handle handle to close *
* PARAMS
* Handle [I] handle to close
*
* RETURNS
* Success: ERROR_SUCCESS.
* Failure: An NTSTATUS error code.
*/ */
NTSTATUS WINAPI NtClose( HANDLE Handle ) NTSTATUS WINAPI NtClose( HANDLE Handle )
{ {
@ -282,12 +288,17 @@ NTSTATUS WINAPI NtWaitForSingleObject(
/************************************************************************** /**************************************************************************
* NtOpenDirectoryObject [NTDLL.@] * NtOpenDirectoryObject [NTDLL.@]
* ZwOpenDirectoryObject [NTDLL.@] * ZwOpenDirectoryObject [NTDLL.@]
* FUNCTION: Opens a namespace directory object *
* ARGUMENTS: * Open a namespace directory object.
* DirectoryHandle Variable which receives the directory handle *
* DesiredAccess Desired access to the directory * PARAMS
* ObjectAttributes Structure describing the directory * DirectoryHandle [O] Destination for the new directory handle
* RETURNS: Status * DesiredAccess [I] Desired access to the directory
* ObjectAttributes [I] Structure describing the directory
*
* RETURNS
* Success: ERROR_SUCCESS.
* Failure: An NTSTATUS error code.
*/ */
NTSTATUS WINAPI NtOpenDirectoryObject( NTSTATUS WINAPI NtOpenDirectoryObject(
PHANDLE DirectoryHandle, PHANDLE DirectoryHandle,
@ -318,16 +329,21 @@ NTSTATUS WINAPI NtCreateDirectoryObject(
/****************************************************************************** /******************************************************************************
* NtQueryDirectoryObject [NTDLL.@] * NtQueryDirectoryObject [NTDLL.@]
* ZwQueryDirectoryObject [NTDLL.@] * ZwQueryDirectoryObject [NTDLL.@]
* FUNCTION: Reads information from a namespace directory *
* ARGUMENTS: * Read information from a namespace directory.
* DirObjInformation Buffer to hold the data read *
* BufferLength Size of the buffer in bytes * PARAMS
* GetNextIndex If TRUE then set ObjectIndex to the index of the next object * DirObjHandle [I] Object handle
* If FALSE then set ObjectIndex to the number of objects in the directory * DirObjInformation [O] Buffer to hold the data read
* IgnoreInputIndex If TRUE start reading at index 0 * BufferLength [I] Size of the buffer in bytes
* If FALSE start reading at the index specified by object index * GetNextIndex [I] Set ObjectIndex to TRUE=next object, FALSE=last object
* ObjectIndex Zero based index into the directory, interpretation depends on IgnoreInputIndex and GetNextIndex * IgnoreInputIndex [I] Start reading at index TRUE=0, FALSE=ObjectIndex
* DataWritten Caller supplied storage for the number of bytes written (or NULL) * ObjectIndex [I/O] 0 based index into the directory, see IgnoreInputIndex and GetNextIndex
* DataWritten [O] Caller supplied storage for the number of bytes written (or NULL)
*
* RETURNS
* Success: ERROR_SUCCESS.
* Failure: An NTSTATUS error code.
*/ */
NTSTATUS WINAPI NtQueryDirectoryObject( NTSTATUS WINAPI NtQueryDirectoryObject(
IN HANDLE DirObjHandle, IN HANDLE DirObjHandle,
@ -394,6 +410,7 @@ NTSTATUS WINAPI NtQuerySymbolicLinkObject(
/****************************************************************************** /******************************************************************************
* NtAllocateUuids [NTDLL.@] * NtAllocateUuids [NTDLL.@]
* *
* NOTES
* I have seen lpdwCount pointing to a pointer once... * I have seen lpdwCount pointing to a pointer once...
*/ */
NTSTATUS WINAPI NtAllocateUuids(LPDWORD lpdwCount, LPDWORD *p2, LPDWORD *p3) NTSTATUS WINAPI NtAllocateUuids(LPDWORD lpdwCount, LPDWORD *p2, LPDWORD *p3)

108
dlls/ntdll/time.c
View File

@ -297,11 +297,11 @@ static inline void NormalizeTimeFields(CSHORT *FieldToNormalize, CSHORT *CarryFi
* *
* Parses Time into a TimeFields structure. * Parses Time into a TimeFields structure.
* *
* PARAMS: * PARAMS
* liTime [I]: Time to convert to timefields. * liTime [I] Time to convert to timefields.
* TimeFields [O]: Pointer to TIME_FIELDS structure to hold parsed info. * TimeFields [O] Pointer to TIME_FIELDS structure to hold parsed info.
* *
* RETURNS: * RETURNS
* Nothing. * Nothing.
*/ */
VOID WINAPI RtlTimeToTimeFields( VOID WINAPI RtlTimeToTimeFields(
@ -360,11 +360,11 @@ VOID WINAPI RtlTimeToTimeFields(
* *
* Converts a TIME_FIELDS structure to time. * Converts a TIME_FIELDS structure to time.
* *
* PARAMS: * PARAMS
* ftTimeFields [I]: Time fields structure to convert. * ftTimeFields [I] Time fields structure to convert.
* Time [O]: Converted time. * Time [O] Converted time.
* *
* RETURNS: * RETURNS
* TRUE: Successfull * TRUE: Successfull
* FALSE: Failure. * FALSE: Failure.
*/ */
@ -418,11 +418,11 @@ BOOLEAN WINAPI RtlTimeFieldsToTime(
* *
* Converts local time to system time. * Converts local time to system time.
* *
* PARAMS: * PARAMS
* LocalTime [I]: Localtime to convert. * LocalTime [I] Localtime to convert.
* SystemTime [O]: SystemTime of the supplied localtime. * SystemTime [O] SystemTime of the supplied localtime.
* *
* RETURNS: * RETURNS
* Status. * Status.
*/ */
NTSTATUS WINAPI RtlLocalTimeToSystemTime( const LARGE_INTEGER *LocalTime, NTSTATUS WINAPI RtlLocalTimeToSystemTime( const LARGE_INTEGER *LocalTime,
@ -442,11 +442,11 @@ NTSTATUS WINAPI RtlLocalTimeToSystemTime( const LARGE_INTEGER *LocalTime,
* *
* Converts system Time to local time. * Converts system Time to local time.
* *
* PARAMS: * PARAMS
* SystemTime [I]: System time to convert. * SystemTime [I] System time to convert.
* LocalTime [O]: Local time of the supplied system time. * LocalTime [O] Local time of the supplied system time.
* *
* RETURNS: * RETURNS
* Nothing. * Nothing.
*/ */
NTSTATUS WINAPI RtlSystemTimeToLocalTime( const LARGE_INTEGER *SystemTime, NTSTATUS WINAPI RtlSystemTimeToLocalTime( const LARGE_INTEGER *SystemTime,
@ -466,11 +466,11 @@ NTSTATUS WINAPI RtlSystemTimeToLocalTime( const LARGE_INTEGER *SystemTime,
* *
* Converts Time to seconds since 1970. * Converts Time to seconds since 1970.
* *
* PARAMS: * PARAMS
* time [I]: Time to convert. * time [I] Time to convert.
* res [O]: Pointer to a LONG to recieve the seconds since 1970. * res [O] Pointer to a LONG to recieve the seconds since 1970.
* *
* RETURNS: * RETURNS
* TRUE: Successfull. * TRUE: Successfull.
* FALSE: Failure. * FALSE: Failure.
*/ */
@ -489,11 +489,11 @@ BOOLEAN WINAPI RtlTimeToSecondsSince1970( const LARGE_INTEGER *time, PULONG res
* *
* Converts Time to seconds since 1980. * Converts Time to seconds since 1980.
* *
* PARAMS: * PARAMS
* time [I]: Time to convert. * time [I] Time to convert.
* res [O]: Pointer to a integer to recieve the time since 1980. * res [O] Pointer to a integer to recieve the time since 1980.
* *
* RETURNS: * RETURNS
* TRUE: Successfull * TRUE: Successfull
* FALSE: Failure. * FALSE: Failure.
*/ */
@ -512,11 +512,11 @@ BOOLEAN WINAPI RtlTimeToSecondsSince1980( const LARGE_INTEGER *time, LPDWORD res
* *
* Converts seconds since 1970 to time. * Converts seconds since 1970 to time.
* *
* PARAMS: * PARAMS
* time [I]: Seconds since 1970 to convert. * time [I] Seconds since 1970 to convert.
* res [O]: Seconds since 1970 in Time. * res [O] Seconds since 1970 in Time.
* *
* RETURNS: * RETURNS
* Nothing. * Nothing.
*/ */
void WINAPI RtlSecondsSince1970ToTime( DWORD time, LARGE_INTEGER *res ) void WINAPI RtlSecondsSince1970ToTime( DWORD time, LARGE_INTEGER *res )
@ -531,11 +531,11 @@ void WINAPI RtlSecondsSince1970ToTime( DWORD time, LARGE_INTEGER *res )
* *
* Converts seconds since 1980 to time. * Converts seconds since 1980 to time.
* *
* PARAMS: * PARAMS
* time [I]: Seconds since 1980 to convert. * time [I] Seconds since 1980 to convert.
* res [O]: Seconds since 1980 in Time. * res [O] Seconds since 1980 in Time.
* *
* RETURNS: * RETURNS
* Nothing. * Nothing.
*/ */
void WINAPI RtlSecondsSince1980ToTime( DWORD time, LARGE_INTEGER *res ) void WINAPI RtlSecondsSince1980ToTime( DWORD time, LARGE_INTEGER *res )
@ -548,7 +548,7 @@ void WINAPI RtlSecondsSince1980ToTime( DWORD time, LARGE_INTEGER *res )
/****************************************************************************** /******************************************************************************
* RtlTimeToElapsedTimeFields [NTDLL.@] * RtlTimeToElapsedTimeFields [NTDLL.@]
* *
* RETURNS: * RETURNS
* Nothing. * Nothing.
*/ */
void WINAPI RtlTimeToElapsedTimeFields( const LARGE_INTEGER *Time, PTIME_FIELDS TimeFields ) void WINAPI RtlTimeToElapsedTimeFields( const LARGE_INTEGER *Time, PTIME_FIELDS TimeFields )
@ -577,10 +577,10 @@ void WINAPI RtlTimeToElapsedTimeFields( const LARGE_INTEGER *Time, PTIME_FIELDS
* *
* Gets the current system time. * Gets the current system time.
* *
* PARAMS: * PARAMS
* time [O]: The current system time. * time [O] The current system time.
* *
* RETURNS: * RETURNS
* Status. * Status.
*/ */
NTSTATUS WINAPI NtQuerySystemTime( PLARGE_INTEGER time ) NTSTATUS WINAPI NtQuerySystemTime( PLARGE_INTEGER time )
@ -597,11 +597,11 @@ NTSTATUS WINAPI NtQuerySystemTime( PLARGE_INTEGER time )
* *
* Helper function calculates delta local time from UTC. * Helper function calculates delta local time from UTC.
* *
* PARAMS: * PARAMS
* utc [I]: The current utc time. * utc [I] The current utc time.
* pdaylight [I]: Local daylight. * pdaylight [I] Local daylight.
* *
* RETURNS: * RETURNS
* The bias for the current timezone. * The bias for the current timezone.
*/ */
static int TIME_GetBias(time_t utc, int *pdaylight) static int TIME_GetBias(time_t utc, int *pdaylight)
@ -618,12 +618,12 @@ static int TIME_GetBias(time_t utc, int *pdaylight)
* *
* Helper function that returns the given timezone as a string. * Helper function that returns the given timezone as a string.
* *
* PARAMS: * PARAMS
* utc [I]: The current utc time. * utc [I] The current utc time.
* bias [I]: The bias of the current timezone. * bias [I] The bias of the current timezone.
* dst [I]: ?? * dst [I] ??
* *
* RETURNS: * RETURNS
* Timezone name. * Timezone name.
* *
* NOTES: * NOTES:
@ -657,10 +657,10 @@ static const WCHAR* TIME_GetTZAsStr (time_t utc, int bias, int dst)
* *
* Returns the timezone. * Returns the timezone.
* *
* PARAMS: * PARAMS
* tzinfo [O]: Retrieves the timezone info. * tzinfo [O] Retrieves the timezone info.
* *
* RETURNS: * RETURNS
* Status. * Status.
*/ */
NTSTATUS WINAPI RtlQueryTimeZoneInformation(LPTIME_ZONE_INFORMATION tzinfo) NTSTATUS WINAPI RtlQueryTimeZoneInformation(LPTIME_ZONE_INFORMATION tzinfo)
@ -687,10 +687,10 @@ NTSTATUS WINAPI RtlQueryTimeZoneInformation(LPTIME_ZONE_INFORMATION tzinfo)
* *
* Sets the current time zone. * Sets the current time zone.
* *
* PARAMS: * PARAMS
* tzinfo [I]: Timezone information used to set timezone. * tzinfo [I] Timezone information used to set timezone.
* *
* RETURNS: * RETURNS
* Status. * Status.
* *
* BUGS: * BUGS:
@ -718,10 +718,10 @@ NTSTATUS WINAPI RtlSetTimeZoneInformation( const TIME_ZONE_INFORMATION *tzinfo )
* Sets the system time. * Sets the system time.
* *
* PARAM: * PARAM:
* NewTime [I]: The time to set the system time to. * NewTime [I] The time to set the system time to.
* OldTime [O]: Optional (ie. can be NULL). Old Time. * OldTime [O] Optional (ie. can be NULL). Old Time.
* *
* RETURNS: * RETURNS
* Status. * Status.
*/ */
NTSTATUS WINAPI NtSetSystemTime(const LARGE_INTEGER *NewTime, LARGE_INTEGER *OldTime) NTSTATUS WINAPI NtSetSystemTime(const LARGE_INTEGER *NewTime, LARGE_INTEGER *OldTime)

259
dlls/oleaut32/dispatch.c
View File

@ -44,85 +44,89 @@ static IDispatch * WINAPI StdDispatch_Construct(IUnknown * punkOuter, void * pvT
/****************************************************************************** /******************************************************************************
* DispInvoke (OLEAUT32.30) * DispInvoke (OLEAUT32.30)
* *
* * Call an object method using the information from its type library.
* Calls method of an object through its IDispatch interface.
*
* NOTES
* - Defer method invocation to ITypeInfo::Invoke()
* *
* RETURNS * RETURNS
* Success: S_OK.
* Failure: Returns DISP_E_EXCEPTION and updates pexcepinfo if an exception occurs.
* DISP_E_BADPARAMCOUNT if the number of parameters is incorrect.
* DISP_E_MEMBERNOTFOUND if the method does not exist.
* puArgErr is updated if a parameter error (see notes) occurs.
* Otherwise, returns the result of calling ITypeInfo_Invoke().
* *
* S_OK on success. * NOTES
* Parameter errors include the following:
*| DISP_E_BADVARTYPE
*| E_INVALIDARG An argument was invalid
*| DISP_E_TYPEMISMATCH,
*| DISP_E_OVERFLOW An argument was valid but could not be coerced
*| DISP_E_PARAMNOTOPTIONAL A non optional parameter was not passed
*| DISP_E_PARAMNOTFOUND A parameter was passed that was not expected by the method
* This call defers to ITypeInfo_Invoke().
*/ */
HRESULT WINAPI DispInvoke( HRESULT WINAPI DispInvoke(
VOID *_this, /* [in] object instance */ VOID *_this, /* [in] Object to call method on */
ITypeInfo *ptinfo, /* [in] object's type info */ ITypeInfo *ptinfo, /* [in] Object type info */
DISPID dispidMember, /* [in] member id */ DISPID dispidMember, /* [in] DISPID of the member (e.g. from GetIDsOfNames()) */
USHORT wFlags, /* [in] kind of method call */ USHORT wFlags, /* [in] Kind of method call (DISPATCH_ flags from "oaidl.h") */
DISPPARAMS *pparams, /* [in] array of arguments */ DISPPARAMS *pparams, /* [in] Array of method arguments */
VARIANT *pvarResult, /* [out] result of method call */ VARIANT *pvarResult, /* [out] Destination for the result of the call */
EXCEPINFO *pexcepinfo, /* [out] information about exception */ EXCEPINFO *pexcepinfo, /* [out] Destination for exception information */
UINT *puArgErr) /* [out] index of bad argument(if any) */ UINT *puArgErr) /* [out] Destination for bad argument */
{ {
HRESULT hr = E_FAIL;
/** /**
* TODO: * TODO:
* For each param, call DispGetParam to perform type coercion * For each param, call DispGetParam to perform type coercion
*/ */
FIXME("Coercion of arguments not implemented\n"); FIXME("Coercion of arguments not implemented\n");
ITypeInfo_Invoke(ptinfo, _this, dispidMember, wFlags, return ITypeInfo_Invoke(ptinfo, _this, dispidMember, wFlags,
pparams, pvarResult, pexcepinfo, puArgErr); pparams, pvarResult, pexcepinfo, puArgErr);
return (hr);
} }
/****************************************************************************** /******************************************************************************
* DispGetIDsOfNames (OLEAUT32.29) * DispGetIDsOfNames (OLEAUT32.29)
* *
* Convert a set of names to dispids, based on information * Convert a set of parameter names to DISPID's for DispInvoke().
* contained in object's type library.
*
* NOTES
* - Defers to ITypeInfo::GetIDsOfNames()
* *
* RETURNS * RETURNS
* Success: S_OK.
* Failure: An HRESULT error code.
* *
* S_OK on success. * NOTES
* This call defers to ITypeInfo_GetIDsOfNames(). The ITypeInfo interface passed
* as ptinfo contains the information to map names to DISPID's.
*/ */
HRESULT WINAPI DispGetIDsOfNames( HRESULT WINAPI DispGetIDsOfNames(
ITypeInfo *ptinfo, /* [in] */ ITypeInfo *ptinfo, /* [in] Object's type info */
OLECHAR **rgszNames, /* [in] */ OLECHAR **rgszNames, /* [in] Array of names to get DISPID's for */
UINT cNames, /* [in] */ UINT cNames, /* [in] Number of names in rgszNames */
DISPID *rgdispid) /* [out] */ DISPID *rgdispid) /* [out] Destination for converted DISPID's */
{ {
HRESULT hr = E_FAIL; return ITypeInfo_GetIDsOfNames(ptinfo, rgszNames, cNames, rgdispid);
ITypeInfo_GetIDsOfNames(ptinfo, rgszNames, cNames, rgdispid);
return (hr);
} }
/****************************************************************************** /******************************************************************************
* DispGetParam (OLEAUT32.28) * DispGetParam (OLEAUT32.28)
* *
* Retrive a parameter from a DISPPARAMS structures and coerce it to * Retrive a parameter from a DISPPARAMS structure and coerce it to the
* specified variant type * specified variant type.
* *
* NOTES * NOTES
* Coercion is done using system (0) locale. * Coercion is done using system (0) locale.
* *
* RETURNS * RETURNS
* * Success: S_OK.
* S_OK on success. * Failure: DISP_E_PARAMNOTFOUND, if position is invalid. or
* DISP_E_TYPEMISMATCH, if the coercion failed. puArgErr is
* set to the index of the argument in pdispparams.
*/ */
HRESULT WINAPI DispGetParam( HRESULT WINAPI DispGetParam(
DISPPARAMS *pdispparams, /* [in] */ DISPPARAMS *pdispparams, /* [in] Parameter list */
UINT position, /* [in] */ UINT position, /* [in] Position of parameter to coerce in pdispparams */
VARTYPE vtTarg, /* [in] */ VARTYPE vtTarg, /* [in] Type of value to coerce to */
VARIANT *pvarResult, /* [out] */ VARIANT *pvarResult, /* [out] Destination for resulting variant */
UINT *puArgErr) /* [out] */ UINT *puArgErr) /* [out] Destination for error code */
{ {
/* position is counted backwards */ /* position is counted backwards */
UINT pos; UINT pos;
@ -150,6 +154,12 @@ HRESULT WINAPI DispGetParam(
/****************************************************************************** /******************************************************************************
* CreateStdDispatch [OLEAUT32.32] * CreateStdDispatch [OLEAUT32.32]
*
* Create and return a standard IDispatch object.
*
* RETURNS
* Success: S_OK. ppunkStdDisp contains the new object.
* Failure: An HRESULT error code.
*/ */
HRESULT WINAPI CreateStdDispatch( HRESULT WINAPI CreateStdDispatch(
IUnknown* punkOuter, IUnknown* punkOuter,
@ -167,16 +177,61 @@ HRESULT WINAPI CreateStdDispatch(
/****************************************************************************** /******************************************************************************
* CreateDispTypeInfo [OLEAUT32.31] * CreateDispTypeInfo [OLEAUT32.31]
*
* Build type information for an object so it can be called through an
* IDispatch interface.
*
* RETURNS
* Success: S_OK. pptinfo contains the created ITypeInfo object.
* Failure: E_INVALIDARG, if one or more arguments is invalid.
*
* NOTES
* This call allows an objects methods to be accessed through IDispatch, by
* building an ITypeInfo object that IDispatch can use to call through.
*/ */
HRESULT WINAPI CreateDispTypeInfo( HRESULT WINAPI CreateDispTypeInfo(
INTERFACEDATA *pidata, INTERFACEDATA *pidata, /* [I] Description of the interface to build type info for */
LCID lcid, LCID lcid, /* [I] Locale Id */
ITypeInfo **pptinfo) ITypeInfo **pptinfo) /* [O] Destination for created ITypeInfo object */
{ {
FIXME("(%p,%ld,%p),stub\n",pidata,lcid,pptinfo); FIXME("(%p,%ld,%p),stub\n",pidata,lcid,pptinfo);
return 0; return 0;
} }
/******************************************************************************
* IDispatch {OLEAUT32}
*
* NOTES
* The IDispatch interface provides a single interface to dispatch method calls,
* regardless of whether the object to be called is in or out of process,
* local or remote (e.g. being called over a network). This interface is late-bound
* (linked at run-time), as opposed to early-bound (linked at compile time).
*
* The interface is used by objects that wish to called by scripting
* languages such as VBA, in order to minimise the amount of COM and C/C++
* knowledge required, or by objects that wish to live out of process from code
* that will call their methods.
*
* Method, property and parameter names can be localised. The details required to
* map names to methods and parameters are collected in a type library, usually
* output by an IDL compiler using the objects IDL description. This information is
* accessable programatically through the ITypeLib interface (for a type library),
* and the ITypeInfo interface (for an object within the type library). Type information
* can also be created at run-time using CreateDispTypeInfo().
*
* WRAPPERS
* Instead of using IDispatch directly, there are several wrapper functions available
* to simplify the process of calling an objects methods through IDispatch.
*
* A standard implementation of an IDispatch object is created by calling
* CreateStdDispatch(). Numeric Id values for the parameters and methods (DISPID's)
* of an object of interest are retrieved by calling DispGetIDsOfNames(). DispGetParam()
* retrieves information about a particular parameter. Finally the DispInvoke()
* function is responsable for actually calling methods on an object.
*
* METHODS
*/
typedef struct typedef struct
{ {
ICOM_VFIELD(IDispatch); ICOM_VFIELD(IDispatch);
@ -186,6 +241,11 @@ typedef struct
ULONG ref; ULONG ref;
} StdDispatch; } StdDispatch;
/******************************************************************************
* IDispatch_QueryInterface {OLEAUT32}
*
* See IUnknown_QueryInterface.
*/
static HRESULT WINAPI StdDispatch_QueryInterface( static HRESULT WINAPI StdDispatch_QueryInterface(
LPDISPATCH iface, LPDISPATCH iface,
REFIID riid, REFIID riid,
@ -207,6 +267,11 @@ static HRESULT WINAPI StdDispatch_QueryInterface(
return E_NOINTERFACE; return E_NOINTERFACE;
} }
/******************************************************************************
* IDispatch_AddRef {OLEAUT32}
*
* See IUnknown_AddRef.
*/
static ULONG WINAPI StdDispatch_AddRef(LPDISPATCH iface) static ULONG WINAPI StdDispatch_AddRef(LPDISPATCH iface)
{ {
ICOM_THIS(StdDispatch, iface); ICOM_THIS(StdDispatch, iface);
@ -218,6 +283,11 @@ static ULONG WINAPI StdDispatch_AddRef(LPDISPATCH iface)
return This->ref; return This->ref;
} }
/******************************************************************************
* IDispatch_Release {OLEAUT32}
*
* See IUnknown_Release.
*/
static ULONG WINAPI StdDispatch_Release(LPDISPATCH iface) static ULONG WINAPI StdDispatch_Release(LPDISPATCH iface)
{ {
ICOM_THIS(StdDispatch, iface); ICOM_THIS(StdDispatch, iface);
@ -237,25 +307,93 @@ static ULONG WINAPI StdDispatch_Release(LPDISPATCH iface)
return ret; return ret;
} }
/******************************************************************************
* IDispatch_GetTypeInfoCount {OLEAUT32}
*
* Get the count of type information in an IDispatch interface.
*
* PARAMS
* iface [I] IDispatch interface
* pctinfo [O] Destination for the count
*
* RETURNS
* Success: S_OK. pctinfo is updated with the count. This is always 1 if
* the object provides type information, and 0 if it does not.
* Failure: E_NOTIMPL. The object does not provide type information.
*
* NOTES
* See IDispatch() and IDispatch_GetTypeInfo().
*/
static HRESULT WINAPI StdDispatch_GetTypeInfoCount(LPDISPATCH iface, UINT * pctinfo) static HRESULT WINAPI StdDispatch_GetTypeInfoCount(LPDISPATCH iface, UINT * pctinfo)
{ {
ICOM_THIS(StdDispatch, iface);
TRACE("(%p)\n", pctinfo); TRACE("(%p)\n", pctinfo);
*pctinfo = 1; *pctinfo = This->pTypeInfo ? 1 : 0;
return S_OK; return S_OK;
} }
/******************************************************************************
* IDispatch_GetTypeInfo {OLEAUT32}
*
* Get type information from an IDispatch interface.
*
* PARAMS
* iface [I] IDispatch interface
* iTInfo [I] Index of type information.
* lcid [I] Locale of the type information to get
* ppTInfo [O] Destination for the ITypeInfo object
*
* RETURNS
* Success: S_OK. ppTInfo is updated with the objects type information
* Failure: DISP_E_BADINDEX, if iTInfo is any value other than 0.
*
* NOTES
* See IDispatch.
*/
static HRESULT WINAPI StdDispatch_GetTypeInfo(LPDISPATCH iface, UINT iTInfo, LCID lcid, ITypeInfo** ppTInfo) static HRESULT WINAPI StdDispatch_GetTypeInfo(LPDISPATCH iface, UINT iTInfo, LCID lcid, ITypeInfo** ppTInfo)
{ {
ICOM_THIS(StdDispatch, iface); ICOM_THIS(StdDispatch, iface);
TRACE("(%d, %lx, %p)\n", iTInfo, lcid, ppTInfo); TRACE("(%d, %lx, %p)\n", iTInfo, lcid, ppTInfo);
*ppTInfo = NULL;
if (iTInfo != 0) if (iTInfo != 0)
return DISP_E_BADINDEX; return DISP_E_BADINDEX;
if (This->pTypeInfo)
{
*ppTInfo = This->pTypeInfo; *ppTInfo = This->pTypeInfo;
ITypeInfo_AddRef(*ppTInfo);
}
return S_OK; return S_OK;
} }
/******************************************************************************
* IDispatch_GetIDsOfNames {OLEAUT32}
*
* Convert a methods name and an optional set of parameter names into DISPID's
* for passing to IDispatch_Invoke().
*
* PARAMS
* iface [I] IDispatch interface
* riid [I] Reserved, set to IID_NULL
* rgszNames [I] Name to convert
* cNames [I] Number of names in rgszNames
* lcid [I] Locale of the type information to convert from
* rgDispId [O] Destination for converted DISPID's.
*
* RETURNS
* Success: S_OK.
* Failure: DISP_E_UNKNOWNNAME, if any of the names is invalid.
* DISP_E_UNKNOWNLCID if lcid is invalid.
* Otherwise, an An HRESULT error code.
*
* NOTES
* This call defers to ITypeInfo_GetIDsOfNames(), using the ITypeInfo object
* contained within the IDispatch object.
* The first member of the names list must be a method name. The names following
* the method name are the parameters for that method.
*/
static HRESULT WINAPI StdDispatch_GetIDsOfNames(LPDISPATCH iface, REFIID riid, LPOLESTR * rgszNames, UINT cNames, LCID lcid, DISPID * rgDispId) static HRESULT WINAPI StdDispatch_GetIDsOfNames(LPDISPATCH iface, REFIID riid, LPOLESTR * rgszNames, UINT cNames, LCID lcid, DISPID * rgDispId)
{ {
ICOM_THIS(StdDispatch, iface); ICOM_THIS(StdDispatch, iface);
@ -269,7 +407,32 @@ static HRESULT WINAPI StdDispatch_GetIDsOfNames(LPDISPATCH iface, REFIID riid, L
return DispGetIDsOfNames(This->pTypeInfo, rgszNames, cNames, rgDispId); return DispGetIDsOfNames(This->pTypeInfo, rgszNames, cNames, rgDispId);
} }
static HRESULT WINAPI StdDispatch_Invoke(LPDISPATCH iface, DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS * pDispParams, VARIANT * pVarResult, EXCEPINFO * pExcepInfo, UINT * puArgErr) /******************************************************************************
* IDispatch_Invoke {OLEAUT32}
*
* Call an object method.
*
* PARAMS
* iface [I] IDispatch interface
* dispIdMember [I] DISPID of the method (from GetIDsOfNames())
* riid [I] Reserved, set to IID_NULL
* lcid [I] Locale of the type information to convert parameters with
* wFlags, [I] Kind of method call (DISPATCH_ flags from "oaidl.h")
* pDispParams [I] Array of method arguments
* pVarResult [O] Destination for the result of the call
* pExcepInfo [O] Destination for exception information
* puArgErr [O] Destination for bad argument
*
* RETURNS
* Success: S_OK.
* Failure: See DispInvoke() for failure cases.
*
* NOTES
* See DispInvoke() and IDispatch().
*/
static HRESULT WINAPI StdDispatch_Invoke(LPDISPATCH iface, DISPID dispIdMember, REFIID riid, LCID lcid,
WORD wFlags, DISPPARAMS * pDispParams, VARIANT * pVarResult,
EXCEPINFO * pExcepInfo, UINT * puArgErr)
{ {
ICOM_THIS(StdDispatch, iface); ICOM_THIS(StdDispatch, iface);
TRACE("(%ld, %s, 0x%lx, 0x%x, %p, %p, %p, %p)\n", dispIdMember, debugstr_guid(riid), lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr); TRACE("(%ld, %s, 0x%lx, 0x%x, %p, %p, %p, %p)\n", dispIdMember, debugstr_guid(riid), lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr);

93
dlls/oleaut32/ole2disp.c
View File

@ -71,34 +71,69 @@ static void* BSTR_GetAddr(BSTR16 in)
/****************************************************************************** /******************************************************************************
* SysAllocString [OLE2DISP.2] * SysAllocString [OLE2DISP.2]
*
* Create a BSTR16 from an OLESTR16 (16 Bit).
*
* PARAMS
* oleStr [I] Source to create BSTR16 from
*
* RETURNS
* Success: A BSTR16 allocated with SysAllocStringLen16().
* Failure: NULL, if oleStr is NULL.
*/ */
BSTR16 WINAPI SysAllocString16(LPCOLESTR16 in) BSTR16 WINAPI SysAllocString16(LPCOLESTR16 oleStr)
{ {
BSTR16 out; BSTR16 out;
if (!in) return 0; if (!oleStr) return 0;
out = BSTR_AllocBytes(strlen(in)+1); out = BSTR_AllocBytes(strlen(oleStr)+1);
if (!out) return 0; if (!out) return 0;
strcpy(BSTR_GetAddr(out),in); strcpy(BSTR_GetAddr(out),oleStr);
return out; return out;
} }
/****************************************************************************** /******************************************************************************
* SysReallocString [OLE2DISP.3] * SysReallocString [OLE2DISP.3]
*
* Change the length of a previously created BSTR16 (16 Bit).
*
* PARAMS
* pbstr [I] BSTR16 to change the length of
* oleStr [I] New source for pbstr
*
* RETURNS
* Success: 1
* Failure: 0.
*
* NOTES
* SysAllocStringStringLen16().
*/ */
INT16 WINAPI SysReAllocString16(LPBSTR16 old,LPCOLESTR16 in) INT16 WINAPI SysReAllocString16(LPBSTR16 pbstr,LPCOLESTR16 oleStr)
{ {
BSTR16 new=SysAllocString16(in); BSTR16 new=SysAllocString16(oleStr);
BSTR_Free(*old); BSTR_Free(*pbstr);
*old=new; *pbstr=new;
return 1; return 1;
} }
/****************************************************************************** /******************************************************************************
* SysAllocStringLen [OLE2DISP.4] * SysAllocStringLen [OLE2DISP.4]
*
* Create a BSTR16 from an OLESTR16 of a given character length (16 Bit).
*
* PARAMS
* oleStr [I] Source to create BSTR16 from
* len [I] Length of oleStr in wide characters
*
* RETURNS
* Success: A newly allocated BSTR16 from SysAllocStringByteLen16()
* Failure: NULL, if len is >= 0x80000000, or memory allocation fails.
*
* NOTES
* See SysAllocStringByteLen16().
*/ */
BSTR16 WINAPI SysAllocStringLen16(const char *in, int len) BSTR16 WINAPI SysAllocStringLen16(const char *oleStr, int len)
{ {
BSTR16 out=BSTR_AllocBytes(len+1); BSTR16 out=BSTR_AllocBytes(len+1);
@ -110,8 +145,8 @@ BSTR16 WINAPI SysAllocStringLen16(const char *in, int len)
* Since it is valid to pass a NULL pointer here, we'll initialize the * Since it is valid to pass a NULL pointer here, we'll initialize the
* buffer to nul if it is the case. * buffer to nul if it is the case.
*/ */
if (in != 0) if (oleStr != 0)
strcpy(BSTR_GetAddr(out),in); strcpy(BSTR_GetAddr(out),oleStr);
else else
memset(BSTR_GetAddr(out), 0, len+1); memset(BSTR_GetAddr(out), 0, len+1);
@ -120,9 +155,25 @@ BSTR16 WINAPI SysAllocStringLen16(const char *in, int len)
/****************************************************************************** /******************************************************************************
* SysReAllocStringLen [OLE2DISP.5] * SysReAllocStringLen [OLE2DISP.5]
*
* Change the length of a previously created BSTR16 (16 Bit).
*
* PARAMS
* pbstr [I] BSTR16 to change the length of
* oleStr [I] New source for pbstr
* len [I] Length of oleStr in characters
*
* RETURNS
* Success: 1. The size of pbstr is updated.
* Failure: 0, if len >= 0x8000 or memory allocation fails.
*
* NOTES
* See SysAllocStringByteLen16().
* *pbstr may be changed by this function.
*/ */
int WINAPI SysReAllocStringLen16(BSTR16 *old,const char *in,int len) int WINAPI SysReAllocStringLen16(BSTR16 *old,const char *in,int len)
{ {
/* FIXME: Check input length */
BSTR16 new=SysAllocStringLen16(in,len); BSTR16 new=SysAllocStringLen16(in,len);
BSTR_Free(*old); BSTR_Free(*old);
*old=new; *old=new;
@ -131,14 +182,30 @@ int WINAPI SysReAllocStringLen16(BSTR16 *old,const char *in,int len)
/****************************************************************************** /******************************************************************************
* SysFreeString [OLE2DISP.6] * SysFreeString [OLE2DISP.6]
*
* Free a BSTR16 (16 Bit).
*
* PARAMS
* str [I] String to free.
*
* RETURNS
* Nothing.
*/ */
void WINAPI SysFreeString16(BSTR16 in) void WINAPI SysFreeString16(BSTR16 str)
{ {
BSTR_Free(in); BSTR_Free(str);
} }
/****************************************************************************** /******************************************************************************
* SysStringLen [OLE2DISP.7] * SysStringLen [OLE2DISP.7]
*
* Get the allocated length of a BSTR16 in characters (16 Bit).
*
* PARAMS
* str [I] BSTR16 to find the length of
*
* RETURNS
* The allocated length of str, or 0 if str is NULL.
*/ */
int WINAPI SysStringLen16(BSTR16 str) int WINAPI SysStringLen16(BSTR16 str)
{ {

80
dlls/oleaut32/typelib16.c
View File

@ -41,21 +41,41 @@
WINE_DEFAULT_DEBUG_CHANNEL(ole); WINE_DEFAULT_DEBUG_CHANNEL(ole);
/*************************************************************************
* TYPELIB {TYPELIB}
*
* This dll is the 16 bit version of the Typelib API, part the original
* implementation of Ole automation. It and its companion ole2disp.dll were
* superceeded by oleaut32.dll which provides 32 bit implementations of these
* functions and greatly extends the Ole Api.
*
* Winelib developers cannot use these functions directly, they are implemented
* solely for backwards compatibility with existing legacy applications.
*
* SEE ALSO
* oleaut32(), ole2disp().
*/
/**************************************************************************** /****************************************************************************
* QueryPathOfRegTypeLib [TYPELIB.14] * QueryPathOfRegTypeLib [TYPELIB.14]
* *
* the path is "Classes\Typelib\<guid>\<major>.<minor>\<lcid>\win16\" * Get the registry key of a registered type library.
*
* RETURNS * RETURNS
* path of typelib * Success: S_OK. path is updated with the key name
* Failure: E_FAIL, if guid was not found in the registry
*
* NOTES
* The key takes the form "Classes\Typelib\<guid>\<major>.<minor>\<lcid>\win16\"
*/ */
HRESULT WINAPI HRESULT WINAPI
QueryPathOfRegTypeLib16( QueryPathOfRegTypeLib16(
REFGUID guid, /* [in] referenced guid */ REFGUID guid, /* [in] Guid to get the key name for */
WORD wMaj, /* [in] major version */ WORD wMaj, /* [in] Major version */
WORD wMin, /* [in] minor version */ WORD wMin, /* [in] Minor version */
LCID lcid, /* [in] locale id */ LCID lcid, /* [in] Locale Id */
LPBSTR16 path /* [out] path of typelib */ LPBSTR16 path) /* [out] Destination for the registry key name */
) { {
char xguid[80]; char xguid[80];
char typelibkey[100],pathname[260]; char typelibkey[100],pathname[260];
DWORD plen; DWORD plen;
@ -86,18 +106,20 @@ QueryPathOfRegTypeLib16(
} }
/****************************************************************************** /******************************************************************************
* LoadTypeLib [TYPELIB.3] Loads and registers a type library * LoadTypeLib [TYPELIB.3]
* NOTES *
* Docs: OLECHAR FAR* szFile * Load and register a type library.
* Docs: iTypeLib FAR* FAR* pptLib
* *
* RETURNS * RETURNS
* Success: S_OK * Success: S_OK. pptLib contains the type libraries ITypeLib interface.
* Failure: Status * Failure: An HRESULT error code.
*
* NOTES
* Both parameters are FAR pointers.
*/ */
HRESULT WINAPI LoadTypeLib16( HRESULT WINAPI LoadTypeLib16(
LPOLESTR szFile, /* [in] Name of file to load from */ LPOLESTR szFile, /* [in] Name of file to load from */
ITypeLib** pptLib) /* [out] Pointer to pointer to loaded type library */ ITypeLib** pptLib) /* [out] Destination for loaded ITypeLib interface */
{ {
FIXME("(%s,%p): stub\n",debugstr_w((LPWSTR)szFile),pptLib); FIXME("(%s,%p): stub\n",debugstr_w((LPWSTR)szFile),pptLib);
@ -110,16 +132,26 @@ HRESULT WINAPI LoadTypeLib16(
/**************************************************************************** /****************************************************************************
* OaBuildVersion (TYPELIB.15) * OaBuildVersion (TYPELIB.15)
* *
* known TYPELIB.DLL versions: * Get the Ole Automation build version.
* *
* OLE 2.01 no OaBuildVersion() avail 1993 -- --- * PARAMS
* OLE 2.02 1993-94 02 3002 * None
* OLE 2.03 23 730 *
* OLE 2.03 03 3025 * RETURNS
* OLE 2.03 W98 SE orig. file !! 1993-95 10 3024 * The build version.
* OLE 2.1 NT 1993-95 ?? ??? *
* OLE 2.3.1 W95 23 700 * NOTES
* OLE2 4.0 NT4SP6 1993-98 40 4277 * Known typelib.dll versions:
*| OLE Ver. Comments Date Build Ver.
*| -------- ------------------------- ---- ---------
*| OLE 2.01 Call not available 1993 N/A
*| OLE 2.02 1993-94 02 3002
*| OLE 2.03 23 730
*| OLE 2.03 03 3025
*| OLE 2.03 W98 SE orig. file !! 1993-95 10 3024
*| OLE 2.1 NT 1993-95 ?? ???
*| OLE 2.3.1 W95 23 700
*| OLE2 4.0 NT4SP6 1993-98 40 4277
*/ */
DWORD WINAPI OaBuildVersion16(void) DWORD WINAPI OaBuildVersion16(void)
{ {

14
dlls/shell32/pidl.c
View File

@ -224,12 +224,6 @@ HRESULT WINAPI ILSaveToStream (IStream * pStream, LPCITEMIDLIST pPidl)
return ret; return ret;
} }
/*************************************************************************
* SHILCreateFromPath [SHELL32.28]
*
* NOTES
* wraper for IShellFolder::ParseDisplayName()
*/
HRESULT WINAPI SHILCreateFromPathA (LPCSTR path, LPITEMIDLIST * ppidl, DWORD * attributes) HRESULT WINAPI SHILCreateFromPathA (LPCSTR path, LPITEMIDLIST * ppidl, DWORD * attributes)
{ LPSHELLFOLDER sf; { LPSHELLFOLDER sf;
WCHAR lpszDisplayName[MAX_PATH]; WCHAR lpszDisplayName[MAX_PATH];
@ -248,6 +242,7 @@ HRESULT WINAPI SHILCreateFromPathA (LPCSTR path, LPITEMIDLIST * ppidl, DWORD * a
} }
return ret; return ret;
} }
HRESULT WINAPI SHILCreateFromPathW (LPCWSTR path, LPITEMIDLIST * ppidl, DWORD * attributes) HRESULT WINAPI SHILCreateFromPathW (LPCWSTR path, LPITEMIDLIST * ppidl, DWORD * attributes)
{ LPSHELLFOLDER sf; { LPSHELLFOLDER sf;
DWORD pchEaten; DWORD pchEaten;
@ -262,6 +257,13 @@ HRESULT WINAPI SHILCreateFromPathW (LPCWSTR path, LPITEMIDLIST * ppidl, DWORD *
} }
return ret; return ret;
} }
/*************************************************************************
* SHILCreateFromPath [SHELL32.28]
*
* NOTES
* Wrapper for IShellFolder_ParseDisplayName().
*/
HRESULT WINAPI SHILCreateFromPathAW (LPCVOID path, LPITEMIDLIST * ppidl, DWORD * attributes) HRESULT WINAPI SHILCreateFromPathAW (LPCVOID path, LPITEMIDLIST * ppidl, DWORD * attributes)
{ {
if ( SHELL_OsIsUnicode()) if ( SHELL_OsIsUnicode())

4
dlls/shell32/shell.c
View File

@ -76,7 +76,9 @@ static int SHELL_Attach = 0;
* Initialization code for shell.dll. Automatically loads the * Initialization code for shell.dll. Automatically loads the
* 32-bit shell32.dll to allow thunking up to 32-bit code. * 32-bit shell32.dll to allow thunking up to 32-bit code.
* *
* RETURNS: * RETURNS
* Success: TRUE. Initialization completed successfully.
* Failure: FALSE.
*/ */
BOOL WINAPI SHELL_DllEntryPoint(DWORD Reason, HINSTANCE16 hInst, BOOL WINAPI SHELL_DllEntryPoint(DWORD Reason, HINSTANCE16 hInst,
WORD ds, WORD HeapSize, DWORD res1, WORD res2) WORD ds, WORD HeapSize, DWORD res1, WORD res2)

14
dlls/shell32/shellole.c
View File

@ -417,11 +417,19 @@ static ICOM_VTABLE(IMalloc) VT_Shell_IMalloc32 =
/************************************************************************* /*************************************************************************
* SHGetMalloc [SHELL32.@] * SHGetMalloc [SHELL32.@]
* returns the interface to shell malloc. *
* Return the shell IMalloc interface.
*
* PARAMS
* lpmal [O] Destination for IMalloc interface.
*
* RETURNS
* Success: S_OK. lpmal contains the shells IMalloc interface.
* Failure. An HRESULT error code.
* *
* NOTES * NOTES
* uses OLE32.CoGetMalloc if OLE32.DLL is already loaded. * This function will use CoGetMalloc() if OLE32.DLL is already loaded.
* if not it uses a internal implementations as fallback. * If not it uses an internal implementation as a fallback.
*/ */
HRESULT WINAPI SHGetMalloc(LPMALLOC *lpmal) HRESULT WINAPI SHGetMalloc(LPMALLOC *lpmal)
{ {

49
dlls/shell32/shellord.c
View File

@ -260,16 +260,21 @@ VOID WINAPI SHGetSettings(LPSHELLFLAGSTATE lpsfs, DWORD dwMask)
/************************************************************************* /*************************************************************************
* SHShellFolderView_Message [SHELL32.73] * SHShellFolderView_Message [SHELL32.73]
* *
* PARAMETERS * Send a message to an explorer cabinet window.
* hwndCabinet defines the explorer cabinet window that contains the *
* shellview you need to communicate with * PARAMS
* uMsg identifying the SFVM enum to perform * hwndCabinet [I] The window containing the shellview to communicate with
* lParam * dwMessage [I] The SFVM message to send
* dwParam [I] Message parameter
*
* RETURNS
* fixme.
* *
* NOTES * NOTES
* Message SFVM_REARRANGE = 1 * Message SFVM_REARRANGE = 1
*
* This message gets sent when a column gets clicked to instruct the * This message gets sent when a column gets clicked to instruct the
* shell view to re-sort the item list. lParam identifies the column * shell view to re-sort the item list. dwParam identifies the column
* that was clicked. * that was clicked.
*/ */
int WINAPI SHShellFolderView_Message( int WINAPI SHShellFolderView_Message(
@ -284,12 +289,14 @@ int WINAPI SHShellFolderView_Message(
/************************************************************************* /*************************************************************************
* RegisterShellHook [SHELL32.181] * RegisterShellHook [SHELL32.181]
* *
* Register a shell hook.
*
* PARAMS * PARAMS
* hwnd [I] window handle * hwnd [I] Window handle
* y [I] flag ???? * dwType [I] Type of hook.
* *
* NOTES * NOTES
* exported by ordinal * Exported by ordinal
*/ */
BOOL WINAPI RegisterShellHook( BOOL WINAPI RegisterShellHook(
HWND hWnd, HWND hWnd,
@ -298,16 +305,11 @@ BOOL WINAPI RegisterShellHook(
FIXME("(%p,0x%08lx):stub.\n",hWnd, dwType); FIXME("(%p,0x%08lx):stub.\n",hWnd, dwType);
return TRUE; return TRUE;
} }
/************************************************************************* /*************************************************************************
* ShellMessageBoxW [SHELL32.182] * ShellMessageBoxW [SHELL32.182]
* *
* Format and output errormessage. * See ShellMessageBoxA.
*
* idText resource ID of title or LPSTR
* idTitle resource ID of title or LPSTR
*
* NOTES
* exported by ordinal
*/ */
int WINAPIV ShellMessageBoxW( int WINAPIV ShellMessageBoxW(
HINSTANCE hInstance, HINSTANCE hInstance,
@ -350,6 +352,21 @@ int WINAPIV ShellMessageBoxW(
/************************************************************************* /*************************************************************************
* ShellMessageBoxA [SHELL32.183] * ShellMessageBoxA [SHELL32.183]
*
* Format and output an error message.
*
* PARAMS
* hInstance [I] Instance handle of message creator
* hWnd [I] Window handle of message creator
* lpText [I] Resource Id of title or LPSTR
* lpCaption [I] Resource Id of title or LPSTR
* uType [I] Type of error message
*
* RETURNS
* A return value from MessageBoxA().
*
* NOTES
* Exported by ordinal
*/ */
int WINAPIV ShellMessageBoxA( int WINAPIV ShellMessageBoxA(
HINSTANCE hInstance, HINSTANCE hInstance,

33
dlls/shell32/shfldr_fs.c
View File

@ -288,26 +288,29 @@ static ULONG WINAPI IShellFolder_fnRelease (IShellFolder2 * iface)
} }
/************************************************************************** /**************************************************************************
* IShellFolder_fnParseDisplayName * IShellFolder_ParseDisplayName {SHELL32}
* PARAMETERS *
* HWND hwndOwner, //[in ] Parent window for any message's * Parse a display name.
* LPBC pbc, //[in ] reserved *
* LPOLESTR lpszDisplayName,//[in ] "Unicode" displayname. * PARAMS
* ULONG* pchEaten, //[out] (unicode) characters processed * hwndOwner [in] Parent window for any message's
* LPITEMIDLIST* ppidl, //[out] complex pidl to item * pbc [in] Reserved
* ULONG* pdwAttributes //[out] items attributes * lpszDisplayName [in] Unicode displayname.
* pchEaten [out] (unicode) characters processed
* ppidl [out] complex pidl to item
* pdwAttributes [out] items attributes
* *
* NOTES * NOTES
* every folder tries to parse only its own (the leftmost) pidl and creates a * Every folder tries to parse only its own (the leftmost) pidl and creates a
* subfolder to evaluate the remaining parts * subfolder to evaluate the remaining parts.
* now we can parse into namespaces implemented by shell extensions * Now we can parse into namespaces implemented by shell extensions
* *
* behaviour on win98: lpszDisplayName=NULL -> chrash * Behaviour on win98: lpszDisplayName=NULL -> crash
* lpszDisplayName="" -> returns mycoputer-pidl * lpszDisplayName="" -> returns mycoputer-pidl
* *
* FIXME: * FIXME
* pdwAttributes: not set * pdwAttributes is not set
* pchEaten: not set like in windows * pchEaten is not set like in windows
*/ */
static HRESULT WINAPI static HRESULT WINAPI
IShellFolder_fnParseDisplayName (IShellFolder2 * iface, IShellFolder_fnParseDisplayName (IShellFolder2 * iface,

2
dlls/shell32/shlfileop.c
View File

@ -179,7 +179,7 @@ DWORD WINAPI SHCreateDirectoryExW(HWND hWnd, LPCWSTR path, LPSECURITY_ATTRIBUTES
* *
* Deletes a file. Also triggers a change notify if one exists. * Deletes a file. Also triggers a change notify if one exists.
* *
* NOTES: * NOTES
* Verified on Win98 / IE 5 (SHELL32 4.72, March 1999 build) to be ANSI. * Verified on Win98 / IE 5 (SHELL32 4.72, March 1999 build) to be ANSI.
* This is Unicode on NT/2000 * This is Unicode on NT/2000
*/ */

99
dlls/shlwapi/path.c
View File

@ -64,11 +64,11 @@ static BOOL (WINAPI *pIsNetDrive)(DWORD);
* *
* RETURNS * RETURNS
* Success: TRUE. lpszPath contains the newly created path. * Success: TRUE. lpszPath contains the newly created path.
* Failure: FALSE, if either path is NULL, or PathCombineA fails. * Failure: FALSE, if either path is NULL, or PathCombineA() fails.
* *
* NOTES * NOTES
* lpszAppend must contain at least one backslash ('\') if not NULL. * lpszAppend must contain at least one backslash ('\') if not NULL.
* Because PathCombineA is used to join the paths, the resulting * Because PathCombineA() is used to join the paths, the resulting
* path is also canonicalized. * path is also canonicalized.
*/ */
BOOL WINAPI PathAppendA (LPSTR lpszPath, LPCSTR lpszAppend) BOOL WINAPI PathAppendA (LPSTR lpszPath, LPCSTR lpszAppend)
@ -114,7 +114,7 @@ BOOL WINAPI PathAppendW(LPWSTR lpszPath, LPCWSTR lpszAppend)
* PARAMS * PARAMS
* lpszDest [O] Destination for combined path * lpszDest [O] Destination for combined path
* lpszDir [I] Directory path * lpszDir [I] Directory path
* liszFile [I] File path * lpszFile [I] File path
* *
* RETURNS * RETURNS
* Success: The output path * Success: The output path
@ -1099,7 +1099,7 @@ BOOL WINAPI SHLWAPI_4(LPWSTR lpszPath,DWORD dwWhich)
* dwWhich [I] Type of executable to search for * dwWhich [I] Type of executable to search for
* *
* RETURNS * RETURNS
* TRUE If the file was found. lpszFile contains the file name. * TRUE If the file was found. lpszPath contains the file name.
* FALSE Otherwise. * FALSE Otherwise.
* *
* NOTES * NOTES
@ -1109,7 +1109,7 @@ BOOL WINAPI SHLWAPI_4(LPWSTR lpszPath,DWORD dwWhich)
* extensions are not checked. * extensions are not checked.
* *
* Ordinals 3-6 are a classic case of MS exposing limited functionality to * Ordinals 3-6 are a classic case of MS exposing limited functionality to
* users (here through PathFindOnPath) and keeping advanced functionality for * users (here through PathFindOnPathA()) and keeping advanced functionality for
* their own developers exclusive use. Monopoly, anyone? * their own developers exclusive use. Monopoly, anyone?
*/ */
BOOL WINAPI SHLWAPI_3(LPSTR lpszPath,DWORD dwWhich) BOOL WINAPI SHLWAPI_3(LPSTR lpszPath,DWORD dwWhich)
@ -1218,7 +1218,7 @@ static BOOL WINAPI SHLWAPI_PathFindInOtherDirs(LPWSTR lpszFile, DWORD dwWhich)
* dwWhich [I] Type of executable to search for * dwWhich [I] Type of executable to search for
* *
* RETURNS * RETURNS
* Success: TRUE. The path to the executable is stored in sFile. * Success: TRUE. The path to the executable is stored in lpszFile.
* Failure: FALSE. The path to the executable is unchanged. * Failure: FALSE. The path to the executable is unchanged.
*/ */
BOOL WINAPI SHLWAPI_5(LPSTR lpszFile,LPCSTR *lppszOtherDirs,DWORD dwWhich) BOOL WINAPI SHLWAPI_5(LPSTR lpszFile,LPCSTR *lppszOtherDirs,DWORD dwWhich)
@ -1331,7 +1331,7 @@ BOOL WINAPI PathFindOnPathW(LPWSTR lpszFile, LPCWSTR *lppszOtherDirs)
* PARAMS * PARAMS
* lpszDest [O] Destination for compacted path * lpszDest [O] Destination for compacted path
* lpszPath [I] Source path * lpszPath [I] Source path
* cchMax [I[ Maximum size of compacted path * cchMax [I] Maximum size of compacted path
* dwFlags [I] Reserved * dwFlags [I] Reserved
* *
* RETURNS * RETURNS
@ -1343,8 +1343,9 @@ BOOL WINAPI PathFindOnPathW(LPWSTR lpszFile, LPCWSTR *lppszOtherDirs)
* The Win32 version of this function contains a bug: When cchMax == 7, * The Win32 version of this function contains a bug: When cchMax == 7,
* 8 bytes will be written to lpszDest. This bug is fixed in the Wine * 8 bytes will be written to lpszDest. This bug is fixed in the Wine
* implementation. * implementation.
*
* Some relative paths will be different when cchMax == 5 or 6. This occurs * Some relative paths will be different when cchMax == 5 or 6. This occurs
* because Win32 will insert a \ in the compact filename, even if one is * because Win32 will insert a "\" in lpszDest, even if one is
* not present in the original path. * not present in the original path.
*/ */
BOOL WINAPI PathCompactPathExA(LPSTR lpszDest, LPCSTR lpszPath, BOOL WINAPI PathCompactPathExA(LPSTR lpszDest, LPCSTR lpszPath,
@ -1511,7 +1512,7 @@ BOOL WINAPI PathIsRelativeW (LPCWSTR lpszPath)
* lpszPath [I] Path to check * lpszPath [I] Path to check
* *
* RETURNS * RETURNS
* TRUE If lpszPath is valid and a root path * TRUE If lpszPath is valid and a root path,
* FALSE Otherwise * FALSE Otherwise
*/ */
BOOL WINAPI PathIsRootA(LPCSTR lpszPath) BOOL WINAPI PathIsRootA(LPCSTR lpszPath)
@ -1605,8 +1606,8 @@ BOOL WINAPI PathIsRootW(LPCWSTR lpszPath)
* Although this function is prototyped as returning a BOOL, it returns * Although this function is prototyped as returning a BOOL, it returns
* FILE_ATTRIBUTE_DIRECTORY for success. This means that code such as: * FILE_ATTRIBUTE_DIRECTORY for success. This means that code such as:
* *
* if (PathIsDirectoryA("c:\\windows\\") == TRUE) *| if (PathIsDirectoryA("c:\\windows\\") == TRUE)
* ... *| ...
* *
* will always fail. * will always fail.
*/ */
@ -1768,7 +1769,7 @@ static BOOL PathMatchSingleMaskW(LPCWSTR name, LPCWSTR mask)
* *
* PARAMS * PARAMS
* lpszPath [I] Path to check * lpszPath [I] Path to check
* lpszMask [I} Search mask(s) * lpszMask [I] Search mask(s)
* *
* RETURNS * RETURNS
* TRUE If lpszPath is valid and is matched * TRUE If lpszPath is valid and is matched
@ -1779,20 +1780,20 @@ static BOOL PathMatchSingleMaskW(LPCWSTR name, LPCWSTR mask)
* pattern "*.*" is treated specially in that it matches all paths (for * pattern "*.*" is treated specially in that it matches all paths (for
* backwards compatability with DOS). * backwards compatability with DOS).
*/ */
BOOL WINAPI PathMatchSpecA(LPCSTR name, LPCSTR mask) BOOL WINAPI PathMatchSpecA(LPCSTR lpszPath, LPCSTR lpszMask)
{ {
TRACE("%s %s\n",name,mask); TRACE("%s %s\n", lpszPath, lpszMask);
if (!lstrcmpA( mask, "*.*" )) return 1; /* we don't require a period */ if (!lstrcmpA( lpszMask, "*.*" )) return 1; /* we don't require a period */
while (*mask) while (*lpszMask)
{ {
if (PathMatchSingleMaskA(name,mask)) return 1; /* helper function */ if (PathMatchSingleMaskA(lpszPath,lpszMask)) return 1; /* helper function */
while (*mask && *mask!=';') mask = CharNextA(mask); while (*lpszMask && *lpszMask!=';') lpszMask = CharNextA(lpszMask);
if (*mask==';') if (*lpszMask==';')
{ {
mask++; lpszMask++;
while (*mask==' ') mask++; /* masks may be separated by "; " */ while (*lpszMask==' ') lpszMask++; /* masks may be separated by "; " */
} }
} }
return 0; return 0;
@ -1882,7 +1883,7 @@ BOOL WINAPI PathIsSameRootW(LPCWSTR lpszPath1, LPCWSTR lpszPath2)
* lpszPath [I] file to check * lpszPath [I] file to check
* *
* RETURNS * RETURNS
* TRUE If lpszPath is a given registered content type * TRUE If lpszPath is a given registered content type,
* FALSE Otherwise. * FALSE Otherwise.
* *
* NOTES * NOTES
@ -1991,7 +1992,7 @@ BOOL WINAPI PathIsFileSpecW(LPCWSTR lpszPath)
* lpszPath [i] Path to check * lpszPath [i] Path to check
* *
* RETURNS * RETURNS
* TRUE If lpszPath has lpszPrefix as its prefix * TRUE If lpszPath has lpszPrefix as its prefix,
* FALSE If either path is NULL or lpszPrefix is not a prefix * FALSE If either path is NULL or lpszPrefix is not a prefix
*/ */
BOOL WINAPI PathIsPrefixA (LPCSTR lpszPrefix, LPCSTR lpszPath) BOOL WINAPI PathIsPrefixA (LPCSTR lpszPrefix, LPCSTR lpszPath)
@ -2030,7 +2031,7 @@ BOOL WINAPI PathIsPrefixW(LPCWSTR lpszPrefix, LPCWSTR lpszPath)
* *
* RETURNS * RETURNS
* TRUE If lpszPath or dwAttrib are a system folder. * TRUE If lpszPath or dwAttrib are a system folder.
* FALSE If GetFileAttributesA fails or neither parameter is a system folder. * FALSE If GetFileAttributesA() fails or neither parameter is a system folder.
*/ */
BOOL WINAPI PathIsSystemFolderA(LPCSTR lpszPath, DWORD dwAttrib) BOOL WINAPI PathIsSystemFolderA(LPCSTR lpszPath, DWORD dwAttrib)
{ {
@ -2230,7 +2231,7 @@ BOOL WINAPI PathIsUNCServerShareW(LPCWSTR lpszPath)
* lpszPath [I] Path to cnonicalize * lpszPath [I] Path to cnonicalize
* *
* RETURNS * RETURNS
* Success: TRUE. lpszBuf contains the output path * Success: TRUE. lpszBuf contains the output path,
* Failure: FALSE, If input path is invalid. lpszBuf is undefined * Failure: FALSE, If input path is invalid. lpszBuf is undefined
*/ */
BOOL WINAPI PathCanonicalizeA(LPSTR lpszBuf, LPCSTR lpszPath) BOOL WINAPI PathCanonicalizeA(LPSTR lpszBuf, LPCSTR lpszPath)
@ -2363,7 +2364,7 @@ BOOL WINAPI PathCanonicalizeW(LPWSTR lpszBuf, LPCWSTR lpszPath)
* lpszPath [I] Path to find next component in * lpszPath [I] Path to find next component in
* *
* RETURNS * RETURNS
* Success: A pointer to the next component, or the end of the string * Success: A pointer to the next component, or the end of the string,
* Failure: NULL, If lpszPath is invalid * Failure: NULL, If lpszPath is invalid
* *
* NOTES * NOTES
@ -2419,15 +2420,15 @@ LPWSTR WINAPI PathFindNextComponentW(LPCWSTR lpszPath)
* *
* PARAMS * PARAMS
* lpszPath [O] Path to add extension to * lpszPath [O] Path to add extension to
* lpszExtension [I} Extension to add to lpszPath * lpszExtension [I] Extension to add to lpszPath
* *
* RETURNS * RETURNS
* TRUE If the path was modified * TRUE If the path was modified,
* FALSE If lpszPath or lpszExtension are invalid, lpszPath has an * FALSE If lpszPath or lpszExtension are invalid, lpszPath has an
* extension allready, or the new path length is too big. * extension allready, or the new path length is too big.
* *
* FIXME * FIXME
* What version of shlwapi.dll adds "exe" if pszExtension is NULL? Win2k * What version of shlwapi.dll adds "exe" if lpszExtension is NULL? Win2k
* does not do this, so the behaviour was removed. * does not do this, so the behaviour was removed.
*/ */
BOOL WINAPI PathAddExtensionA(LPSTR lpszPath, LPCSTR lpszExtension) BOOL WINAPI PathAddExtensionA(LPSTR lpszPath, LPCSTR lpszExtension)
@ -2480,7 +2481,7 @@ BOOL WINAPI PathAddExtensionW(LPWSTR lpszPath, LPCWSTR lpszExtension)
* lpszPath [O] Path to convert. * lpszPath [O] Path to convert.
* *
* RETURNS * RETURNS
* TRUE If the path was an uppercase DOS path and was converted * TRUE If the path was an uppercase DOS path and was converted,
* FALSE Otherwise. * FALSE Otherwise.
*/ */
BOOL WINAPI PathMakePrettyA(LPSTR lpszPath) BOOL WINAPI PathMakePrettyA(LPSTR lpszPath)
@ -2835,7 +2836,7 @@ end:
* ch [I] Character to get the type of * ch [I] Character to get the type of
* *
* RETURNS * RETURNS
* A set of GCT_ bit flags (from shlwapi.h) indicating the character type. * A set of GCT_ bit flags (from "shlwapi.h") indicating the character type.
*/ */
UINT WINAPI PathGetCharTypeA(UCHAR ch) UINT WINAPI PathGetCharTypeA(UCHAR ch)
{ {
@ -2909,7 +2910,7 @@ static BOOL SHLWAPI_UseSystemForSystemFolders()
* *
* RETURNS * RETURNS
* TRUE If the path was changed to/already was a system folder * TRUE If the path was changed to/already was a system folder
* FALSE If the path is invalid or SetFileAttributesA fails * FALSE If the path is invalid or SetFileAttributesA() fails
*/ */
BOOL WINAPI PathMakeSystemFolderA(LPCSTR lpszPath) BOOL WINAPI PathMakeSystemFolderA(LPCSTR lpszPath)
{ {
@ -2968,12 +2969,12 @@ BOOL WINAPI PathMakeSystemFolderW(LPCWSTR lpszPath)
* Swap the file extension in a path with another extension. * Swap the file extension in a path with another extension.
* *
* PARAMS * PARAMS
* pszPath [O] Path to swap the extension in * lpszPath [O] Path to swap the extension in
* pszExt [I] The new extension * lpszExt [I] The new extension
* *
* RETURNS * RETURNS
* TRUE if pszPath was modified * TRUE if lpszPath was modified,
* FALSE if pszPath or pszExt is NULL, or the new path is too long * FALSE if lpszPath or lpszExt is NULL, or the new path is too long
*/ */
BOOL WINAPI PathRenameExtensionA(LPSTR lpszPath, LPCSTR lpszExt) BOOL WINAPI PathRenameExtensionA(LPSTR lpszPath, LPCSTR lpszExt)
{ {
@ -3050,7 +3051,7 @@ BOOL WINAPI PathSearchAndQualifyW(LPCWSTR lpszPath, LPWSTR lpszBuf, UINT cchBuf)
* *
* RETURNS * RETURNS
* Success: A pointer to the next character after the root. * Success: A pointer to the next character after the root.
* Failure: NULL, if lpszPath is invalid, has no root or is a MB string. * Failure: NULL, if lpszPath is invalid, has no root or is a multibyte string.
*/ */
LPSTR WINAPI PathSkipRootA(LPCSTR lpszPath) LPSTR WINAPI PathSkipRootA(LPCSTR lpszPath)
{ {
@ -3118,7 +3119,7 @@ LPWSTR WINAPI PathSkipRootW(LPCWSTR lpszPath)
* dwFlags [I] Flags controlling the conversion * dwFlags [I] Flags controlling the conversion
* *
* RETURNS * RETURNS
* Success: S_OK. lpszPath contains the URL in path format * Success: S_OK. lpszPath contains the URL in path format,
* Failure: An HRESULT error code such as E_INVALIDARG. * Failure: An HRESULT error code such as E_INVALIDARG.
*/ */
HRESULT WINAPI PathCreateFromUrlA(LPCSTR lpszUrl, LPSTR lpszPath, HRESULT WINAPI PathCreateFromUrlA(LPCSTR lpszUrl, LPSTR lpszPath,
@ -3209,6 +3210,7 @@ HRESULT WINAPI PathCreateFromUrlW(LPCWSTR lpszUrl, LPWSTR lpszPath,
* *
* NOTES * NOTES
* lpszTo should be at least MAX_PATH in length. * lpszTo should be at least MAX_PATH in length.
*
* Calling this function with relative paths for lpszFrom or lpszTo may * Calling this function with relative paths for lpszFrom or lpszTo may
* give erroneous results. * give erroneous results.
* *
@ -3216,8 +3218,9 @@ HRESULT WINAPI PathCreateFromUrlW(LPCWSTR lpszUrl, LPWSTR lpszPath,
* may be referenced 1 byte beyond the end of the string. As a result random * may be referenced 1 byte beyond the end of the string. As a result random
* garbage may be written to the output path, depending on what lies beyond * garbage may be written to the output path, depending on what lies beyond
* the last byte of the string. This bug occurs because of the behaviour of * the last byte of the string. This bug occurs because of the behaviour of
* PathCommonPrefix (see notes for that function), and no workaround seems * PathCommonPrefix() (see notes for that function), and no workaround seems
* possible with Win32. * possible with Win32.
*
* This bug has been fixed here, so for example the relative path from "\\" * This bug has been fixed here, so for example the relative path from "\\"
* to "\\" is correctly determined as "." in this implementation. * to "\\" is correctly determined as "." in this implementation.
*/ */
@ -3322,7 +3325,7 @@ BOOL WINAPI PathRelativePathToW(LPWSTR lpszPath, LPCWSTR lpszFrom, DWORD dwAttrF
* RETURNS * RETURNS
* Success: TRUE. * Success: TRUE.
* Failure: FALSE, if lpszPath is NULL, empty, not a directory, or calling * Failure: FALSE, if lpszPath is NULL, empty, not a directory, or calling
* SetFileAttributesA fails. * SetFileAttributesA() fails.
*/ */
BOOL WINAPI PathUnmakeSystemFolderA(LPCSTR lpszPath) BOOL WINAPI PathUnmakeSystemFolderA(LPCSTR lpszPath)
{ {
@ -3435,8 +3438,8 @@ VOID WINAPI PathSetDlgItemPathW(HWND hDlg, int id, LPCWSTR lpszPath)
* lpszPath [I] Path to check * lpszPath [I] Path to check
* *
* RETURNS * RETURNS
* TRUE If path is a UNC share or mapped network drive * TRUE If lpszPath is a UNC share or mapped network drive, or
* FALSE If path is a local drive or cannot be determined * FALSE If lpszPath is a local drive or cannot be determined
*/ */
BOOL WINAPI PathIsNetworkPathA(LPCSTR lpszPath) BOOL WINAPI PathIsNetworkPathA(LPCSTR lpszPath)
{ {
@ -3486,7 +3489,7 @@ BOOL WINAPI PathIsNetworkPathW(LPCWSTR lpszPath)
* lpszPath [I] Path to check * lpszPath [I] Path to check
* *
* RETURNS * RETURNS
* TRUE If path is a long file name * TRUE If path is a long file name,
* FALSE If path is a valid DOS 8.3 file name * FALSE If path is a valid DOS 8.3 file name
*/ */
BOOL WINAPI PathIsLFNFileSpecA(LPCSTR lpszPath) BOOL WINAPI PathIsLFNFileSpecA(LPCSTR lpszPath)
@ -3575,7 +3578,7 @@ BOOL WINAPI PathIsLFNFileSpecW(LPCWSTR lpszPath)
* lpszPath [I] Directory to check * lpszPath [I] Directory to check
* *
* RETURNS * RETURNS
* TRUE If the directory exists and contains no files * TRUE If the directory exists and contains no files,
* FALSE Otherwise * FALSE Otherwise
*/ */
BOOL WINAPI PathIsDirectoryEmptyA(LPCSTR lpszPath) BOOL WINAPI PathIsDirectoryEmptyA(LPCSTR lpszPath)
@ -3645,13 +3648,13 @@ BOOL WINAPI PathIsDirectoryEmptyW(LPCWSTR lpszPath)
* dwCount [I] Number of elements in lppszArray * dwCount [I] Number of elements in lppszArray
* *
* RETURNS * RETURNS
* Success The index of the position of lpszSuffix in lppszArray * Success: The index of the position of lpszSuffix in lppszArray
* Failure 0, if any parameters are invalid or lpszSuffix is not found * Failure: 0, if any parameters are invalid or lpszSuffix is not found
* *
* NOTES * NOTES
* The search is case sensitive. * The search is case sensitive.
* The match is made against the end of the suffix string, so for example: * The match is made against the end of the suffix string, so for example:
* lpszSuffix=fooBAR matches BAR, but lpszSuffix=fooBARfoo does not. * lpszSuffix="fooBAR" matches "BAR", but lpszSuffix="fooBARfoo" does not.
*/ */
int WINAPI PathFindSuffixArrayA(LPCSTR lpszSuffix, LPCSTR *lppszArray, int dwCount) int WINAPI PathFindSuffixArrayA(LPCSTR lpszSuffix, LPCSTR *lppszArray, int dwCount)
{ {
@ -3722,7 +3725,7 @@ int WINAPI PathFindSuffixArrayW(LPCWSTR lpszSuffix, LPCWSTR *lppszArray, int dwC
* Nothing * Nothing
* *
* NOTES * NOTES
* A decorations form is "path[n].ext" where n is an optional decimal number. * A decorations form is "path[n].ext" where "n" is an optional decimal number.
*/ */
VOID WINAPI PathUndecorateA(LPSTR lpszPath) VOID WINAPI PathUndecorateA(LPSTR lpszPath)
{ {

228
dlls/shlwapi/reg.c
View File

@ -89,13 +89,17 @@ HKEY REG_GetHKEYFromHUSKEY(HUSKEY hUSKey, BOOL which)
* SHRegOpenUSKeyA [SHLWAPI.@] * SHRegOpenUSKeyA [SHLWAPI.@]
* *
* Opens a user-specific registry key * Opens a user-specific registry key
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from RegOpenKeyExA().
*/ */
LONG WINAPI SHRegOpenUSKeyA( LONG WINAPI SHRegOpenUSKeyA(
LPCSTR Path, LPCSTR Path, /* [I] Key name to open */
REGSAM AccessType, REGSAM AccessType, /* [I] Access type */
HUSKEY hRelativeUSKey, HUSKEY hRelativeUSKey, /* [I] Relative user key */
PHUSKEY phNewUSKey, PHUSKEY phNewUSKey, /* [O] Destination for created key */
BOOL fIgnoreHKCU) BOOL fIgnoreHKCU) /* [I] TRUE=Don't check HKEY_CURRENT_USER */
{ {
HKEY openHKCUkey=0; HKEY openHKCUkey=0;
HKEY openHKLMkey=0; HKEY openHKLMkey=0;
@ -155,7 +159,7 @@ LONG WINAPI SHRegOpenUSKeyA(
/************************************************************************* /*************************************************************************
* SHRegOpenUSKeyW [SHLWAPI.@] * SHRegOpenUSKeyW [SHLWAPI.@]
* *
* Opens a user-specific registry key * See SHRegOpenUSKeyA.
*/ */
LONG WINAPI SHRegOpenUSKeyW( LONG WINAPI SHRegOpenUSKeyW(
LPCWSTR Path, LPCWSTR Path,
@ -221,10 +225,14 @@ LONG WINAPI SHRegOpenUSKeyW(
/************************************************************************* /*************************************************************************
* SHRegCloseUSKey [SHLWAPI.@] * SHRegCloseUSKey [SHLWAPI.@]
* *
* Closes a user-specific registry key * Close a user-specific registry key
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from RegCloseKey().
*/ */
LONG WINAPI SHRegCloseUSKey( LONG WINAPI SHRegCloseUSKey(
HUSKEY hUSKey) HUSKEY hUSKey) /* [I] Key to close */
{ {
LPInternal_HUSKEY mihk = (LPInternal_HUSKEY)hUSKey; LPInternal_HUSKEY mihk = (LPInternal_HUSKEY)hUSKey;
LONG ret = ERROR_SUCCESS; LONG ret = ERROR_SUCCESS;
@ -239,16 +247,22 @@ LONG WINAPI SHRegCloseUSKey(
/************************************************************************* /*************************************************************************
* SHRegQueryUSValueA [SHLWAPI.@] * SHRegQueryUSValueA [SHLWAPI.@]
*
* Query a user-specific registry value.
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from RegQueryValueExA().
*/ */
LONG WINAPI SHRegQueryUSValueA( LONG WINAPI SHRegQueryUSValueA(
HUSKEY hUSKey, /* [in] */ HUSKEY hUSKey, /* [I] Key to query */
LPCSTR pszValue, LPCSTR pszValue, /* [I] Value name under hUSKey */
LPDWORD pdwType, LPDWORD pdwType, /* [O] Destination for value type */
LPVOID pvData, LPVOID pvData, /* [O] Destination for value data */
LPDWORD pcbData, LPDWORD pcbData, /* [O] Destination for value length */
BOOL fIgnoreHKCU, BOOL fIgnoreHKCU, /* [I] TRUE=Don't check HKEY_CURRENT_USER */
LPVOID pvDefaultData, LPVOID pvDefaultData, /* [I] Default data if pszValue does not exist */
DWORD dwDefaultDataSize) DWORD dwDefaultDataSize) /* [I] Length of pvDefaultData */
{ {
LONG ret = ~ERROR_SUCCESS; LONG ret = ~ERROR_SUCCESS;
LONG i, maxmove; LONG i, maxmove;
@ -288,9 +302,11 @@ LONG WINAPI SHRegQueryUSValueA(
/************************************************************************* /*************************************************************************
* SHRegQueryUSValueW [SHLWAPI.@] * SHRegQueryUSValueW [SHLWAPI.@]
*
* See SHRegQueryUSValueA.
*/ */
LONG WINAPI SHRegQueryUSValueW( LONG WINAPI SHRegQueryUSValueW(
HUSKEY hUSKey, /* [in] */ HUSKEY hUSKey,
LPCWSTR pszValue, LPCWSTR pszValue,
LPDWORD pdwType, LPDWORD pdwType,
LPVOID pvData, LPVOID pvData,
@ -337,18 +353,24 @@ LONG WINAPI SHRegQueryUSValueW(
/************************************************************************* /*************************************************************************
* SHRegGetUSValueA [SHLWAPI.@] * SHRegGetUSValueA [SHLWAPI.@]
* *
* Gets a user-specific registry value * Get a user-specific registry value.
* Will open the key, query the value, and close the key *
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from SHRegOpenUSKeyA() or SHRegQueryUSValueA().
*
* NOTES
* This function opens pSubKey, queries the value, and then closes the key.
*/ */
LONG WINAPI SHRegGetUSValueA( LONG WINAPI SHRegGetUSValueA(
LPCSTR pSubKey, LPCSTR pSubKey, /* [I] Key name to open */
LPCSTR pValue, LPCSTR pValue, /* [I] Value name to open */
LPDWORD pwType, LPDWORD pwType, /* [O] Destination for the type of the value */
LPVOID pvData, LPVOID pvData, /* [O] Destination for the value */
LPDWORD pcbData, LPDWORD pcbData, /* [I] Destination for the length of the value **/
BOOL flagIgnoreHKCU, BOOL flagIgnoreHKCU, /* [I] TRUE=Don't check HKEY_CURRENT_USER */
LPVOID pDefaultData, LPVOID pDefaultData, /* [I] Default value if it doesn't exist */
DWORD wDefaultDataSize) DWORD wDefaultDataSize) /* [I] Length of pDefaultData */
{ {
HUSKEY myhuskey; HUSKEY myhuskey;
LONG ret; LONG ret;
@ -371,8 +393,7 @@ LONG WINAPI SHRegGetUSValueA(
/************************************************************************* /*************************************************************************
* SHRegGetUSValueW [SHLWAPI.@] * SHRegGetUSValueW [SHLWAPI.@]
* *
* Gets a user-specific registry value * See SHRegGetUSValueA.
* Will open the key, query the value, and close the key
*/ */
LONG WINAPI SHRegGetUSValueW( LONG WINAPI SHRegGetUSValueW(
LPCWSTR pSubKey, LPCWSTR pSubKey,
@ -464,12 +485,25 @@ LONG WINAPI SHRegSetUSValueW(
/************************************************************************* /*************************************************************************
* SHRegGetBoolUSValueA [SHLWAPI.@] * SHRegGetBoolUSValueA [SHLWAPI.@]
*
* Get a user-specific registry boolean value.
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from SHRegOpenUSKeyA() or SHRegQueryUSValueA().
*
* NOTES
* This function opens pszSubKey, queries the value, and then closes the key.
*
* Boolean values are one of the following:
* True: YES,TRUE,non-zero
* False: NO,FALSE,0
*/ */
BOOL WINAPI SHRegGetBoolUSValueA( BOOL WINAPI SHRegGetBoolUSValueA(
LPCSTR pszSubKey, LPCSTR pszSubKey, /* [I] Key name to open */
LPCSTR pszValue, LPCSTR pszValue, /* [I] Value name to open */
BOOL fIgnoreHKCU, BOOL fIgnoreHKCU, /* [I] TRUE=Don't check HKEY_CURRENT_USER */
BOOL fDefault) BOOL fDefault) /* [I] Default value to use if pszValue is not present */
{ {
LONG retvalue; LONG retvalue;
DWORD type, datalen, work; DWORD type, datalen, work;
@ -519,6 +553,8 @@ BOOL WINAPI SHRegGetBoolUSValueA(
/************************************************************************* /*************************************************************************
* SHRegGetBoolUSValueW [SHLWAPI.@] * SHRegGetBoolUSValueW [SHLWAPI.@]
*
* See SHRegGetBoolUSValueA.
*/ */
BOOL WINAPI SHRegGetBoolUSValueW( BOOL WINAPI SHRegGetBoolUSValueW(
LPCWSTR pszSubKey, LPCWSTR pszSubKey,
@ -578,14 +614,20 @@ BOOL WINAPI SHRegGetBoolUSValueW(
/************************************************************************* /*************************************************************************
* SHRegQueryInfoUSKeyA [SHLWAPI.@] * SHRegQueryInfoUSKeyA [SHLWAPI.@]
*
* Get information about a user-specific registry key.
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from RegQueryInfoKeyA().
*/ */
LONG WINAPI SHRegQueryInfoUSKeyA( LONG WINAPI SHRegQueryInfoUSKeyA(
HUSKEY hUSKey, /* [in] */ HUSKEY hUSKey, /* [I] Key to query */
LPDWORD pcSubKeys, LPDWORD pcSubKeys, /* [O] Destination for number of sub keys */
LPDWORD pcchMaxSubKeyLen, LPDWORD pcchMaxSubKeyLen, /* [O] Destination for the length of the biggest sub key name */
LPDWORD pcValues, LPDWORD pcValues, /* [O] Destination for number of values */
LPDWORD pcchMaxValueNameLen, LPDWORD pcchMaxValueNameLen,/* [O] Destination for the length of the biggest value */
SHREGENUM_FLAGS enumRegFlags) SHREGENUM_FLAGS enumRegFlags) /* [in] SHREGENUM_ flags from "shlwapi.h" */
{ {
HKEY dokey; HKEY dokey;
LONG ret; LONG ret;
@ -617,9 +659,11 @@ LONG WINAPI SHRegQueryInfoUSKeyA(
/************************************************************************* /*************************************************************************
* SHRegQueryInfoUSKeyW [SHLWAPI.@] * SHRegQueryInfoUSKeyW [SHLWAPI.@]
*
* See SHRegQueryInfoUSKeyA.
*/ */
LONG WINAPI SHRegQueryInfoUSKeyW( LONG WINAPI SHRegQueryInfoUSKeyW(
HUSKEY hUSKey, /* [in] */ HUSKEY hUSKey,
LPDWORD pcSubKeys, LPDWORD pcSubKeys,
LPDWORD pcchMaxSubKeyLen, LPDWORD pcchMaxSubKeyLen,
LPDWORD pcValues, LPDWORD pcValues,
@ -656,13 +700,19 @@ LONG WINAPI SHRegQueryInfoUSKeyW(
/************************************************************************* /*************************************************************************
* SHRegEnumUSKeyA [SHLWAPI.@] * SHRegEnumUSKeyA [SHLWAPI.@]
*
* Enumerate a user-specific registry key.
*
* RETURNS
* Success: ERROR_SUCCESS
* Failure: An error code from RegEnumKeyExA().
*/ */
LONG WINAPI SHRegEnumUSKeyA( LONG WINAPI SHRegEnumUSKeyA(
HUSKEY hUSKey, /* [in] */ HUSKEY hUSKey, /* [in] Key to enumerate */
DWORD dwIndex, /* [in] */ DWORD dwIndex, /* [in] Index within hUSKey */
LPSTR pszName, /* [out] */ LPSTR pszName, /* [out] Name of the enumerated value */
LPDWORD pcchValueNameLen, /* [in/out] */ LPDWORD pcchValueNameLen, /* [in/out] Length of pszName */
SHREGENUM_FLAGS enumRegFlags) /* [in] */ SHREGENUM_FLAGS enumRegFlags) /* [in] SHREGENUM_ flags from "shlwapi.h" */
{ {
HKEY dokey; HKEY dokey;
@ -689,13 +739,15 @@ LONG WINAPI SHRegEnumUSKeyA(
/************************************************************************* /*************************************************************************
* SHRegEnumUSKeyW [SHLWAPI.@] * SHRegEnumUSKeyW [SHLWAPI.@]
*
* See SHRegEnumUSKeyA.
*/ */
LONG WINAPI SHRegEnumUSKeyW( LONG WINAPI SHRegEnumUSKeyW(
HUSKEY hUSKey, /* [in] */ HUSKEY hUSKey,
DWORD dwIndex, /* [in] */ DWORD dwIndex,
LPWSTR pszName, /* [out] */ LPWSTR pszName,
LPDWORD pcchValueNameLen, /* [in/out] */ LPDWORD pcchValueNameLen,
SHREGENUM_FLAGS enumRegFlags) /* [in] */ SHREGENUM_FLAGS enumRegFlags)
{ {
HKEY dokey; HKEY dokey;
@ -722,6 +774,8 @@ LONG WINAPI SHRegEnumUSKeyW(
/************************************************************************* /*************************************************************************
* SHRegWriteUSValueA [SHLWAPI.@] * SHRegWriteUSValueA [SHLWAPI.@]
*
*
*/ */
LONG WINAPI SHRegWriteUSValueA(HUSKEY hUSKey, LPCSTR pszValue, DWORD dwType, LONG WINAPI SHRegWriteUSValueA(HUSKEY hUSKey, LPCSTR pszValue, DWORD dwType,
LPVOID pvData, DWORD cbData, DWORD dwFlags) LPVOID pvData, DWORD cbData, DWORD dwFlags)
@ -750,6 +804,8 @@ LONG WINAPI SHRegWriteUSValueA(HUSKEY hUSKey, LPCSTR pszValue, DWORD dwType,
/************************************************************************* /*************************************************************************
* SHRegWriteUSValueW [SHLWAPI.@] * SHRegWriteUSValueW [SHLWAPI.@]
*
* See SHRegWriteUSValueA.
*/ */
LONG WINAPI SHRegWriteUSValueW(HUSKEY hUSKey, LPCWSTR pszValue, DWORD dwType, LONG WINAPI SHRegWriteUSValueW(HUSKEY hUSKey, LPCWSTR pszValue, DWORD dwType,
LPVOID pvData, DWORD cbData, DWORD dwFlags) LPVOID pvData, DWORD cbData, DWORD dwFlags)
@ -790,7 +846,7 @@ LONG WINAPI SHRegWriteUSValueW(HUSKEY hUSKey, LPCWSTR pszValue, DWORD dwType,
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. lpszPath contains the path. * Success: ERROR_SUCCESS. lpszPath contains the path.
* Failure: An error code from RegOpenKeyExA or SHQueryValueExA. * Failure: An error code from RegOpenKeyExA() or SHQueryValueExA().
*/ */
DWORD WINAPI SHRegGetPathA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue, DWORD WINAPI SHRegGetPathA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue,
LPSTR lpszPath, DWORD dwFlags) LPSTR lpszPath, DWORD dwFlags)
@ -830,7 +886,7 @@ DWORD WINAPI SHRegGetPathW(HKEY hKey, LPCWSTR lpszSubKey, LPCWSTR lpszValue,
* lpszSubKey [I] Name of sub key containing path to set * lpszSubKey [I] Name of sub key containing path to set
* lpszValue [I] Name of value containing path to set * lpszValue [I] Name of value containing path to set
* lpszPath [O] Path to write * lpszPath [O] Path to write
* dwFlags [I] Reserved * dwFlags [I] Reserved, must be 0.
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. * Success: ERROR_SUCCESS.
@ -888,7 +944,7 @@ DWORD WINAPI SHRegSetPathW(HKEY hKey, LPCWSTR lpszSubKey, LPCWSTR lpszValue,
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. Output parameters contain the details read. * Success: ERROR_SUCCESS. Output parameters contain the details read.
* Failure: An error code from RegOpenKeyExA or SHQueryValueExA. * Failure: An error code from RegOpenKeyExA() or SHQueryValueExA().
*/ */
DWORD WINAPI SHGetValueA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue, DWORD WINAPI SHGetValueA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue,
LPDWORD pwType, LPVOID pvData, LPDWORD pcbData) LPDWORD pwType, LPVOID pvData, LPDWORD pcbData)
@ -954,11 +1010,11 @@ DWORD WINAPI SHGetValueW(HKEY hKey, LPCWSTR lpszSubKey, LPCWSTR lpszValue,
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. The value is set with the data given. * Success: ERROR_SUCCESS. The value is set with the data given.
* Failure: An error code from RegCreateKeyExA or RegSetValueExA * Failure: An error code from RegCreateKeyExA() or RegSetValueExA()
* *
* NOTES * NOTES
* If the sub key does not exist, it is created before the value is set. If * If lpszSubKey does not exist, it is created before the value is set. If
* The sub key is NULL or an empty string, then the value is added directly * lpszSubKey is NULL or an empty string, then the value is added directly
* to hKey instead. * to hKey instead.
*/ */
DWORD WINAPI SHSetValueA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue, DWORD WINAPI SHSetValueA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue,
@ -1017,7 +1073,7 @@ DWORD WINAPI SHSetValueW(HKEY hKey, LPCWSTR lpszSubKey, LPCWSTR lpszValue,
/************************************************************************* /*************************************************************************
* SHQueryInfoKeyA [SHLWAPI.@] * SHQueryInfoKeyA [SHLWAPI.@]
* *
* Get information about a registry key. See RegQueryInfoKeyA. * Get information about a registry key. See RegQueryInfoKeyA().
*/ */
LONG WINAPI SHQueryInfoKeyA(HKEY hKey, LPDWORD pwSubKeys, LPDWORD pwSubKeyMax, LONG WINAPI SHQueryInfoKeyA(HKEY hKey, LPDWORD pwSubKeys, LPDWORD pwSubKeyMax,
LPDWORD pwValues, LPDWORD pwValueMax) LPDWORD pwValues, LPDWORD pwValueMax)
@ -1056,11 +1112,11 @@ LONG WINAPI SHQueryInfoKeyW(HKEY hKey, LPDWORD pwSubKeys, LPDWORD pwSubKeyMax,
* pcbData [O] Optional pointer updated with the values size * pcbData [O] Optional pointer updated with the values size
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. Any non-NULL output parameters are updated with * Success: ERROR_SUCCESS. Any non NULL output parameters are updated with
* information about the value. * information about the value.
* Failure: ERROR_OUTOFMEMORY if memory allocation fails, or the type of the * Failure: ERROR_OUTOFMEMORY if memory allocation fails, or the type of the
* data is REG_EXPAND_SZ and pcbData is NULL. Otherwise an error * data is REG_EXPAND_SZ and pcbData is NULL. Otherwise an error
* code from RegQueryValueExA or ExpandEnvironmentStringsA. * code from RegQueryValueExA() or ExpandEnvironmentStringsA().
* *
* NOTES * NOTES
* Either pwType, pvData or pcbData may be NULL if the caller doesn't want * Either pwType, pvData or pcbData may be NULL if the caller doesn't want
@ -1070,16 +1126,16 @@ LONG WINAPI SHQueryInfoKeyW(HKEY hKey, LPDWORD pwSubKeys, LPDWORD pwSubKeyMax,
* value returned will be truncated if it is of type REG_SZ and bigger than * value returned will be truncated if it is of type REG_SZ and bigger than
* the buffer given to store it. * the buffer given to store it.
* *
* REG_EXPAND_SZ * REG_EXPAND_SZ:
* case 1: the unexpanded string is smaller than the expanded one * case-1: the unexpanded string is smaller than the expanded one
* subcase 1: the buffer is to small to hold the unexpanded string: * subcase-1: the buffer is to small to hold the unexpanded string:
* function fails and returns the size of the unexpanded string. * function fails and returns the size of the unexpanded string.
* *
* subcase 2: buffer is to small to hold the expanded string: * subcase-2: buffer is to small to hold the expanded string:
* the function return success (!!) and the result is truncated * the function return success (!!) and the result is truncated
* *** This is clearly a error in the native implemantation. *** * *** This is clearly a error in the native implementation. ***
* *
* case 2: the unexpanded string is bigger than the expanded one * case-2: the unexpanded string is bigger than the expanded one
* The buffer must have enough space to hold the unexpanded * The buffer must have enough space to hold the unexpanded
* string even if the result is smaller. * string even if the result is smaller.
* *
@ -1207,8 +1263,8 @@ DWORD WINAPI SHQueryValueExW(HKEY hKey, LPCWSTR lpszValue,
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. The key is deleted. * Success: ERROR_SUCCESS. The key is deleted.
* Failure: An error code from RegOpenKeyExA, RegQueryInfoKeyA, * Failure: An error code from RegOpenKeyExA(), RegQueryInfoKeyA(),
* RegEnumKeyExA or RegDeleteKeyA. * RegEnumKeyExA() or RegDeleteKeyA().
*/ */
DWORD WINAPI SHDeleteKeyA(HKEY hKey, LPCSTR lpszSubKey) DWORD WINAPI SHDeleteKeyA(HKEY hKey, LPCSTR lpszSubKey)
{ {
@ -1318,8 +1374,8 @@ DWORD WINAPI SHDeleteKeyW(HKEY hKey, LPCWSTR lpszSubKey)
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. The key is deleted. * Success: ERROR_SUCCESS. The key is deleted.
* Failure: If the key is not empty, returns ERROR_KEY_HAS_CHILDREN. Otherwise * Failure: If the key is not empty, returns ERROR_KEY_HAS_CHILDREN. Otherwise
* returns an error code from RegOpenKeyExA, RegQueryInfoKeyA or * returns an error code from RegOpenKeyExA(), RegQueryInfoKeyA() or
* RegDeleteKeyA. * RegDeleteKeyA().
*/ */
DWORD WINAPI SHDeleteEmptyKeyA(HKEY hKey, LPCSTR lpszSubKey) DWORD WINAPI SHDeleteEmptyKeyA(HKEY hKey, LPCSTR lpszSubKey)
{ {
@ -1385,7 +1441,7 @@ DWORD WINAPI SHDeleteEmptyKeyW(HKEY hKey, LPCWSTR lpszSubKey)
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. The key has been deleted if it was an orphan. * Success: ERROR_SUCCESS. The key has been deleted if it was an orphan.
* Failure: An error from RegOpenKeyExA, RegQueryValueExA, or RegDeleteKeyA. * Failure: An error from RegOpenKeyExA(), RegQueryValueExA(), or RegDeleteKeyA().
*/ */
DWORD WINAPI SHDeleteOrphanKeyA(HKEY hKey, LPCSTR lpszSubKey) DWORD WINAPI SHDeleteOrphanKeyA(HKEY hKey, LPCSTR lpszSubKey)
{ {
@ -1452,7 +1508,7 @@ DWORD WINAPI SHDeleteOrphanKeyW(HKEY hKey, LPCWSTR lpszSubKey)
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. The value is deleted. * Success: ERROR_SUCCESS. The value is deleted.
* Failure: An error code from RegOpenKeyExA or RegDeleteValueA. * Failure: An error code from RegOpenKeyExA() or RegDeleteValueA().
*/ */
DWORD WINAPI SHDeleteValueA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue) DWORD WINAPI SHDeleteValueA(HKEY hKey, LPCSTR lpszSubKey, LPCSTR lpszValue)
{ {
@ -1504,7 +1560,7 @@ DWORD WINAPI SHDeleteValueW(HKEY hKey, LPCWSTR lpszSubKey, LPCWSTR lpszValue)
* *
* RETURN * RETURN
* Success: ERROR_SUCCESS. lpszSubKey and pwLen are updated. * Success: ERROR_SUCCESS. lpszSubKey and pwLen are updated.
* Failure: An error code from RegEnumKeyExA. * Failure: An error code from RegEnumKeyExA().
*/ */
LONG WINAPI SHEnumKeyExA(HKEY hKey, DWORD dwIndex, LPSTR lpszSubKey, LONG WINAPI SHEnumKeyExA(HKEY hKey, DWORD dwIndex, LPSTR lpszSubKey,
LPDWORD pwLen) LPDWORD pwLen)
@ -1543,7 +1599,7 @@ LONG WINAPI SHEnumKeyExW(HKEY hKey, DWORD dwIndex, LPWSTR lpszSubKey,
* *
* RETURNS * RETURNS
* Success: ERROR_SUCCESS. Output parameters are updated. * Success: ERROR_SUCCESS. Output parameters are updated.
* Failure: An error code from RegEnumValueA. * Failure: An error code from RegEnumValueA().
*/ */
LONG WINAPI SHEnumValueA(HKEY hKey, DWORD dwIndex, LPSTR lpszValue, LONG WINAPI SHEnumValueA(HKEY hKey, DWORD dwIndex, LPSTR lpszValue,
LPDWORD pwLen, LPDWORD pwType, LPDWORD pwLen, LPDWORD pwType,
@ -1575,7 +1631,20 @@ LONG WINAPI SHEnumValueW(HKEY hKey, DWORD dwIndex, LPWSTR lpszValue,
/************************************************************************* /*************************************************************************
* @ [SHLWAPI.205] * @ [SHLWAPI.205]
* *
* Wrapper for SHGetValueA in case machine is in safe mode. * Get a value from the registry.
*
* PARAMS
* hKey [I] Handle to registry key
* pSubKey [I] Name of sub key containing value to get
* pValue [I] Name of value to get
* pwType [O] Destination for the values type
* pvData [O] Destination for the values data
* pbData [O] Destination for the values size
*
* RETURNS
* Success: ERROR_SUCCESS. Output parameters contain the details read.
* Failure: An error code from RegOpenKeyExA() or SHQueryValueExA(),
* or ERROR_INVALID_FUNCTION in the machine is in safe mode.
*/ */
DWORD WINAPI SHLWAPI_205(HKEY hkey, LPCSTR pSubKey, LPCSTR pValue, DWORD WINAPI SHLWAPI_205(HKEY hkey, LPCSTR pSubKey, LPCSTR pValue,
LPDWORD pwType, LPVOID pvData, LPDWORD pbData) LPDWORD pwType, LPVOID pvData, LPDWORD pbData)
@ -1843,6 +1912,14 @@ BOOL WINAPI SHLWAPI_327(LPCWSTR lpszType)
/************************************************************************* /*************************************************************************
* SHRegDuplicateHKey [SHLWAPI.@] * SHRegDuplicateHKey [SHLWAPI.@]
*
* Create a duplicate of a registry handle.
*
* PARAMS
* hKey [I] key to duplicate.
*
* RETURNS
* A new handle pointing to the same key as hKey.
*/ */
HKEY WINAPI SHRegDuplicateHKey(HKEY hKey) HKEY WINAPI SHRegDuplicateHKey(HKEY hKey)
{ {
@ -1871,7 +1948,8 @@ HKEY WINAPI SHRegDuplicateHKey(HKEY hKey)
* *
* NOTES * NOTES
* If hKeyDst is a key under hKeySrc, this function will misbehave * If hKeyDst is a key under hKeySrc, this function will misbehave
* (It will loop until out of stack, or the registry is full). * (It will loop until out of stack, or the registry is full). This
* bug is present in Win32 also.
*/ */
DWORD WINAPI SHCopyKeyA(HKEY hKeyDst, LPCSTR lpszSubKey, HKEY hKeySrc, DWORD dwReserved) DWORD WINAPI SHCopyKeyA(HKEY hKeyDst, LPCSTR lpszSubKey, HKEY hKeySrc, DWORD dwReserved)
{ {

14
dlls/shlwapi/regstream.c
View File

@ -469,14 +469,14 @@ IStream * WINAPI SHOpenRegStreamW(HKEY hkey, LPCWSTR pszSubkey,
/************************************************************************* /*************************************************************************
* @ [SHLWAPI.12] * @ [SHLWAPI.12]
* *
* Create a stream on a block of memory. * Create an IStream object on a block of memory.
* *
* PARAMS * PARAMS
* lpbData [I] Memory block to create the stream on * lpbData [I] Memory block to create the IStream object on
* dwDataLen [I] Length of data block * dwDataLen [I] Length of data block
* *
* RETURNS * RETURNS
* Success: A pointer to the stream object. * Success: A pointer to the IStream object.
* Failure: NULL, if any parameters are invalid or an error occurs. * Failure: NULL, if any parameters are invalid or an error occurs.
* *
* NOTES * NOTES
@ -508,16 +508,16 @@ IStream * WINAPI SHLWAPI_12(LPBYTE lpbData, DWORD dwDataLen)
/************************************************************************* /*************************************************************************
* SHCreateStreamWrapper [SHLWAPI.@] * SHCreateStreamWrapper [SHLWAPI.@]
* *
* Create a stream on a block of memory. * Create an IStream object on a block of memory.
* *
* PARAMS * PARAMS
* lpbData [I] Memory block to create the stream on * lpbData [I] Memory block to create the IStream object on
* dwDataLen [I] Length of data block * dwDataLen [I] Length of data block
* dwReserved [I] Reserved, Must be 0. * dwReserved [I] Reserved, Must be 0.
* lppStream [O] Destination for stream object * lppStream [O] Destination for IStream object
* *
* RETURNS * RETURNS
* Success: S_OK. lppStream contains the new stream object. * Success: S_OK. lppStream contains the new IStream object.
* Failure: E_INVALIDARG, if any parameters are invalid, * Failure: E_INVALIDARG, if any parameters are invalid,
* E_OUTOFMEMORY if memory allocation fails. * E_OUTOFMEMORY if memory allocation fails.
* *

57
dlls/shlwapi/shlwapi_main.c
View File

@ -39,6 +39,20 @@ HMODULE SHLWAPI_hversion = 0;
DWORD SHLWAPI_ThreadRef_index = -1; DWORD SHLWAPI_ThreadRef_index = -1;
/*************************************************************************
* SHLWAPI {SHLWAPI}
*
* The Shell Light-Weight Api dll provides a large number of utility functions
* which are commonly required by Win32 programs. Originally distributed with
* Internet Explorer as a free download, it became a core part of Windows when
* Internet Explorer was 'integrated' into the O/S with the release of Win98.
*
* All functions exported by ordinal are undocumented by MS. The vast majority
* of these are wrappers for Unicode functions that may not exist on early 16
* bit platforms. The remainder perform various small tasks and presumably were
* added to facilitate code reuse amongst the MS developers.
*/
/************************************************************************* /*************************************************************************
* SHLWAPI DllMain * SHLWAPI DllMain
* *
@ -71,35 +85,40 @@ BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID fImpLoad)
/*********************************************************************** /***********************************************************************
* DllGetVersion [SHLWAPI.@] * DllGetVersion [SHLWAPI.@]
* *
* Retrieves version information of the 'SHLWAPI.DLL' * Retrieve "shlwapi.dll" version information.
* *
* PARAMS * PARAMS
* pdvi [O] pointer to version information structure. * pdvi [O] pointer to version information structure.
* *
* RETURNS * RETURNS
* Success: S_OK * Success: S_OK. pdvi is updated with the version information
* Failure: E_INVALIDARG * Failure: E_INVALIDARG, if pdvi->cbSize is not set correctly.
* *
* NOTES * NOTES
* Returns version of a SHLWAPI.dll from IE5.01. * You may pass either a DLLVERSIONINFO of DLLVERSIONINFO2 structure
* as pdvi, provided that the size is set correctly.
* Returns version as shlwapi.dll from IE5.01.
*/ */
HRESULT WINAPI SHLWAPI_DllGetVersion (DLLVERSIONINFO *pdvi) HRESULT WINAPI SHLWAPI_DllGetVersion (DLLVERSIONINFO *pdvi)
{ {
if (pdvi->cbSize != sizeof(DLLVERSIONINFO)) DLLVERSIONINFO2 *pdvi2 = (DLLVERSIONINFO2*)pdvi;
TRACE("(%p)\n",pdvi);
switch (pdvi2->info1.cbSize)
{ {
WARN("wrong DLLVERSIONINFO size from app\n"); case sizeof(DLLVERSIONINFO2):
return E_INVALIDARG; pdvi2->dwFlags = 0;
} pdvi2->ullVersion = MAKEDLLVERULL(5, 0, 2314, 0);
/* Fall through */
pdvi->dwMajorVersion = 5; case sizeof(DLLVERSIONINFO):
pdvi->dwMinorVersion = 0; pdvi2->info1.dwMajorVersion = 5;
pdvi->dwBuildNumber = 2314; pdvi2->info1.dwMinorVersion = 0;
pdvi->dwPlatformID = 1000; pdvi2->info1.dwBuildNumber = 2314;
pdvi2->info1.dwPlatformID = 1000;
TRACE("%lu.%lu.%lu.%lu\n",
pdvi->dwMajorVersion, pdvi->dwMinorVersion,
pdvi->dwBuildNumber, pdvi->dwPlatformID);
return S_OK; return S_OK;
}
if (pdvi)
WARN("pdvi->cbSize = %ld, unhandled\n", pdvi2->info1.cbSize);
return E_INVALIDARG;
} }

30
dlls/shlwapi/string.c
View File

@ -113,7 +113,7 @@ static BOOL WINAPI SHLWAPI_ChrCmpA(WORD ch1, WORD ch2)
} }
/************************************************************************* /*************************************************************************
* ChrCmpIA [SHLWAPI.385] * ChrCmpIA (SHLWAPI.385)
* *
* Compare two characters, ignoring case. * Compare two characters, ignoring case.
* *
@ -367,9 +367,9 @@ INT WINAPI StrCmpNW(LPCWSTR lpszStr, LPCWSTR lpszComp, INT iLen)
* The Win32 version of this function is _completely_ broken for cases * The Win32 version of this function is _completely_ broken for cases
* where iLen is greater than the length of lpszComp. Examples: * where iLen is greater than the length of lpszComp. Examples:
* *
* StrCmpNIA("foo.gif", "foo", 5) is -1 under Win32; Should return 1. *| StrCmpNIA("foo.gif", "foo", 5) is -1 under Win32; Should return 1.
* StrCmpNIA("\", "\\", 3) is 0 under Win32; Should return -1. *| StrCmpNIA("\", "\\", 3) is 0 under Win32; Should return -1.
* StrCmpNIA("\", "\..\foo\", 3) is 1 under Win32; Should return -1. *| StrCmpNIA("\", "\..\foo\", 3) is 1 under Win32; Should return -1.
* *
* This implementation behaves correctly, since it is unlikely any * This implementation behaves correctly, since it is unlikely any
* applications actually rely on this function being broken. * applications actually rely on this function being broken.
@ -893,8 +893,8 @@ BOOL WINAPI StrToIntExW(LPCWSTR lpszStr, DWORD dwFlags, LPINT lpiRet)
* Failure: NULL, if memory cannot be allocated * Failure: NULL, if memory cannot be allocated
* *
* NOTES * NOTES
* The string memory is allocated with LocalAlloc, and so should be released * The string memory is allocated with LocalAlloc(), and so should be released
* by calling LocalFree. * by calling LocalFree().
*/ */
LPSTR WINAPI StrDupA(LPCSTR lpszStr) LPSTR WINAPI StrDupA(LPCSTR lpszStr)
{ {
@ -1342,7 +1342,7 @@ LPWSTR WINAPI StrCatBuffW(LPWSTR lpszStr, LPCWSTR lpszCat, INT cchMax)
* RETURNS * RETURNS
* Success: S_OK. lpszDest contains up to dwLen characters of the string. * Success: S_OK. lpszDest contains up to dwLen characters of the string.
* If lpStrRet is of type STRRET_WSTR, its memory is freed with * If lpStrRet is of type STRRET_WSTR, its memory is freed with
* CoTaskMemFree and its type set to STRRET_CSTRA. * CoTaskMemFree() and its type set to STRRET_CSTRA.
* Failure: E_FAIL, if any parameters are invalid. * Failure: E_FAIL, if any parameters are invalid.
*/ */
HRESULT WINAPI StrRetToBufA (LPSTRRET src, const ITEMIDLIST *pidl, LPSTR dest, DWORD len) HRESULT WINAPI StrRetToBufA (LPSTRRET src, const ITEMIDLIST *pidl, LPSTR dest, DWORD len)
@ -1736,7 +1736,7 @@ static HRESULT WINAPI _SHStrDupAA(LPCSTR src, LPSTR * dest)
/************************************************************************* /*************************************************************************
* SHStrDupA * SHStrDupA
* *
* Return a Unicode copy of a string, in memory allocated by CoTaskMemAlloc. * Return a Unicode copy of a string, in memory allocated by CoTaskMemAlloc().
* *
* PARAMS * PARAMS
* lpszStr [I] String to copy * lpszStr [I] String to copy
@ -1753,7 +1753,7 @@ HRESULT WINAPI SHStrDupA(LPCSTR src, LPWSTR * dest)
int len = 0; int len = 0;
if (src) { if (src) {
len = MultiByteToWideChar(0,0,src,-1,0,0) * sizeof(WCHAR); len = MultiByteToWideChar(0,0,src,-1,0,0)* sizeof(WCHAR);
*dest = CoTaskMemAlloc(len); *dest = CoTaskMemAlloc(len);
} else { } else {
*dest = NULL; *dest = NULL;
@ -1902,17 +1902,19 @@ static int SHLWAPI_WriteTimeClass(LPWSTR lpszOut, DWORD dwValue,
* NOTES * NOTES
* This implementation mimics the Win32 behaviour of always writing a leading * This implementation mimics the Win32 behaviour of always writing a leading
* space before the time interval begins. * space before the time interval begins.
*
* iDigits is used to provide approximate times if accuracy is not important. * iDigits is used to provide approximate times if accuracy is not important.
* This number of digits will be written of the first non-zero time class * This number of digits will be written of the first non-zero time class
* (hours/minutes/seconds). If this does not complete the time classification, * (hours/minutes/seconds). If this does not complete the time classification,
* the remaining digits are changed to zeros (i.e. The time is _not_ rounded). * the remaining digits are changed to zeros (i.e. The time is _not_ rounded).
* If there are digits remaining following the writing of a time class, the * If there are digits remaining following the writing of a time class, the
* next time class will be written. * next time class will be written.
*
* For example, given dwMS represents 138 hours,43 minutes and 15 seconds, the * For example, given dwMS represents 138 hours,43 minutes and 15 seconds, the
* following will result from the given values of iDigits: * following will result from the given values of iDigits:
* *
* iDigits 1 2 3 4 5 ... *| iDigits 1 2 3 4 5 ...
* lpszStr "100 hr" "130 hr" "138 hr" "138 hr 40 min" "138 hr 43 min" ... *| lpszStr "100 hr" "130 hr" "138 hr" "138 hr 40 min" "138 hr 43 min" ...
*/ */
INT WINAPI StrFromTimeIntervalA(LPSTR lpszStr, UINT cchMax, DWORD dwMS, INT WINAPI StrFromTimeIntervalA(LPSTR lpszStr, UINT cchMax, DWORD dwMS,
int iDigits) int iDigits)
@ -2186,7 +2188,7 @@ typedef struct tagSHLWAPI_BYTEFORMATS
* lpszDest. * lpszDest.
* *
* NOTES * NOTES
* There is no StrFormatByteSize64W function, it is called StrFormatByteSizeW. * There is no StrFormatByteSize64W function, it is called StrFormatByteSizeW().
*/ */
LPSTR WINAPI StrFormatByteSize64A(LONGLONG llBytes, LPSTR lpszDest, UINT cchMax) LPSTR WINAPI StrFormatByteSize64A(LONGLONG llBytes, LPSTR lpszDest, UINT cchMax)
{ {
@ -2293,8 +2295,8 @@ LPWSTR WINAPI StrFormatByteSizeW(LONGLONG llBytes, LPWSTR lpszDest,
* lpszDest. * lpszDest.
* *
* NOTES * NOTES
* The ASCII and Unicode versions of this function accept a different * The Ascii and Unicode versions of this function accept a different
* integer size for dwBytes. See StrFormatByteSize64A. * integer type for dwBytes. See StrFormatByteSize64A().
*/ */
LPSTR WINAPI StrFormatByteSizeA(DWORD dwBytes, LPSTR lpszDest, UINT cchMax) LPSTR WINAPI StrFormatByteSizeA(DWORD dwBytes, LPSTR lpszDest, UINT cchMax)
{ {

16
dlls/shlwapi/thread.c
View File

@ -104,7 +104,7 @@ WINAPI _CreateAllAccessSecurityAttributes(
* Get an interface to the shell explorer. * Get an interface to the shell explorer.
* *
* PARAMS * PARAMS
* lpUnknown [O] pointer to recieve interface. * lppUnknown [O] pointer to recieve IUnknown interface.
* *
* RETURNS * RETURNS
* Success: S_OK. lppUnknown contains the explorer interface. * Success: S_OK. lppUnknown contains the explorer interface.
@ -141,8 +141,8 @@ typedef struct tagSHLWAPI_THREAD_INFO
* lppUnknown [O] Destination to receive object reference * lppUnknown [O] Destination to receive object reference
* *
* RETURNS * RETURNS
* Success: S_OK. lppUnk is set to the object reference. * Success: S_OK. lppUnknown is set to the object reference.
* Failure: E_NOINTERFACE, if an error occurs or lppUnk is invalid. * Failure: E_NOINTERFACE, if an error occurs or lppUnknown is NULL.
*/ */
HRESULT WINAPI SHGetThreadRef(IUnknown **lppUnknown) HRESULT WINAPI SHGetThreadRef(IUnknown **lppUnknown)
{ {
@ -166,11 +166,11 @@ HRESULT WINAPI SHGetThreadRef(IUnknown **lppUnknown)
* Store a per-thread object reference. * Store a per-thread object reference.
* *
* PARAMS * PARAMS
* lpUnk [I] Object reference to store * lpUnknown [I] Object reference to store
* *
* RETURNS * RETURNS
* Success: S_OK. lpUnk is stored and can be retrieved by SHGetThreadRef() * Success: S_OK. lpUnknown is stored and can be retrieved by SHGetThreadRef()
* Failure: E_NOINTERFACE, if an error occurs or lpUnk is invalid. * Failure: E_NOINTERFACE, if an error occurs or lpUnknown is NULL.
*/ */
HRESULT WINAPI SHSetThreadRef(IUnknown *lpUnknown) HRESULT WINAPI SHSetThreadRef(IUnknown *lpUnknown)
{ {
@ -254,9 +254,7 @@ static DWORD WINAPI SHLWAPI_ThreadWrapper(PVOID pTi)
} }
/************************************************************************* /*************************************************************************
* @ [SHLWAPI.16] * SHCreateThread [SHLWAPI.16]
*
* SHCreateThread
* *
* Create a new thread. * Create a new thread.
* *

176
dlls/shlwapi/url.c
View File

@ -259,8 +259,15 @@ static BOOL URL_JustLocation(LPCWSTR str)
/************************************************************************* /*************************************************************************
* @ [SHLWAPI.1] * @ [SHLWAPI.1]
* *
* Identifies the Internet "scheme" in the passed string. ASCII based. * Parse a Url into its constituent parts.
* Also determines start and length of item after the ':' *
* PARAMS
* x [I] Url to parse
* y [O] Undocumented structure holding the parsed information
*
* RETURNS
* Success: S_OK. y contains the parsed Url details.
* Failure: An HRESULT error code.
*/ */
DWORD WINAPI SHLWAPI_1 (LPCSTR x, UNKNOWN_SHLWAPI_1 *y) DWORD WINAPI SHLWAPI_1 (LPCSTR x, UNKNOWN_SHLWAPI_1 *y)
{ {
@ -314,8 +321,7 @@ DWORD WINAPI SHLWAPI_1 (LPCSTR x, UNKNOWN_SHLWAPI_1 *y)
/************************************************************************* /*************************************************************************
* @ [SHLWAPI.2] * @ [SHLWAPI.2]
* *
* Identifies the Internet "scheme" in the passed string. UNICODE based. * Unicode version of SHLWAPI_1.
* Also determines start and length of item after the ':'
*/ */
DWORD WINAPI SHLWAPI_2 (LPCWSTR x, UNKNOWN_SHLWAPI_2 *y) DWORD WINAPI SHLWAPI_2 (LPCWSTR x, UNKNOWN_SHLWAPI_2 *y)
{ {
@ -375,7 +381,27 @@ DWORD WINAPI SHLWAPI_2 (LPCWSTR x, UNKNOWN_SHLWAPI_2 *y)
/************************************************************************* /*************************************************************************
* UrlCanonicalizeA [SHLWAPI.@] * UrlCanonicalizeA [SHLWAPI.@]
* *
* Uses the W version to do job. * Canonicalize a Url.
*
* PARAMS
* pszUrl [I] Url to cCanonicalize
* pszCanonicalized [O] Destination for converted Url.
* pcchCanonicalized [I/O] Length of pszUrl, destination for length of pszCanonicalized
* dwFlags [I] Flags controlling the conversion.
*
* RETURNS
* Success: S_OK. The pszCanonicalized contains the converted Url.
* Failure: E_POINTER, if *pcchCanonicalized is too small.
*
* MSDN is wrong (at 10/30/01 - go figure). This should support the
* following flags: GLA
*| URL_DONT_ESCAPE_EXTRA_INFO 0x02000000
*| URL_ESCAPE_SPACES_ONLY 0x04000000
*| URL_ESCAPE_PERCENT 0x00001000
*| URL_ESCAPE_UNSAFE 0x10000000
*| URL_UNESCAPE 0x10000000
*| URL_DONT_SIMPLIFY 0x08000000
*| URL_ESCAPE_SEGMENT_ONLY 0x00002000
*/ */
HRESULT WINAPI UrlCanonicalizeA(LPCSTR pszUrl, LPSTR pszCanonicalized, HRESULT WINAPI UrlCanonicalizeA(LPCSTR pszUrl, LPSTR pszCanonicalized,
LPDWORD pcchCanonicalized, DWORD dwFlags) LPDWORD pcchCanonicalized, DWORD dwFlags)
@ -416,16 +442,7 @@ HRESULT WINAPI UrlCanonicalizeA(LPCSTR pszUrl, LPSTR pszCanonicalized,
/************************************************************************* /*************************************************************************
* UrlCanonicalizeW [SHLWAPI.@] * UrlCanonicalizeW [SHLWAPI.@]
* *
* * See UrlCanonicalizeA.
* MSDN is wrong (at 10/30/01 - go figure). This should support the
* following flags: GLA
* URL_DONT_ESCAPE_EXTRA_INFO 0x02000000
* URL_ESCAPE_SPACES_ONLY 0x04000000
* URL_ESCAPE_PERCENT 0x00001000
* URL_ESCAPE_UNSAFE 0x10000000
* URL_UNESCAPE 0x10000000
* URL_DONT_SIMPLIFY 0x08000000
* URL_ESCAPE_SEGMENT_ONLY 0x00002000
*/ */
HRESULT WINAPI UrlCanonicalizeW(LPCWSTR pszUrl, LPWSTR pszCanonicalized, HRESULT WINAPI UrlCanonicalizeW(LPCWSTR pszUrl, LPWSTR pszCanonicalized,
LPDWORD pcchCanonicalized, DWORD dwFlags) LPDWORD pcchCanonicalized, DWORD dwFlags)
@ -886,6 +903,7 @@ HRESULT WINAPI UrlCombineW(LPCWSTR pszBase, LPCWSTR pszRelative,
* *
* Converts unsafe characters into their escape sequences. * Converts unsafe characters into their escape sequences.
* *
* NOTES
* The converted string is returned in pszEscaped if the buffer size * The converted string is returned in pszEscaped if the buffer size
* (which should be supplied in pcchEscaped) is large enough, in this * (which should be supplied in pcchEscaped) is large enough, in this
* case the function returns S_OK and pcchEscaped contains the length * case the function returns S_OK and pcchEscaped contains the length
@ -900,10 +918,10 @@ HRESULT WINAPI UrlCombineW(LPCWSTR pszBase, LPCWSTR pszRelative,
* *
* BUGS: * BUGS:
* Have now implemented the following flags: * Have now implemented the following flags:
* URL_ESCAPE_SPACES_ONLY *| URL_ESCAPE_SPACES_ONLY
* URL_DONT_ESCAPE_EXTRA_INFO *| URL_DONT_ESCAPE_EXTRA_INFO
* URL_ESCAPE_SEGMENT_ONLY *| URL_ESCAPE_SEGMENT_ONLY
* URL_ESCAPE_PERCENT *| URL_ESCAPE_PERCENT
* Initial testing seems to indicate that this is now working like * Initial testing seems to indicate that this is now working like
* native shlwapi version 5. Note that these functions did not work * native shlwapi version 5. Note that these functions did not work
* well (or at all) in shlwapi version 4. * well (or at all) in shlwapi version 4.
@ -980,7 +998,7 @@ HRESULT WINAPI UrlEscapeA(
/************************************************************************* /*************************************************************************
* UrlEscapeW [SHLWAPI.@] * UrlEscapeW [SHLWAPI.@]
* *
* See UrlEscapeA for list of assumptions, bugs, and FIXMEs * See UrlEscapeA.
*/ */
HRESULT WINAPI UrlEscapeW( HRESULT WINAPI UrlEscapeW(
LPCWSTR pszUrl, LPCWSTR pszUrl,
@ -1072,17 +1090,20 @@ HRESULT WINAPI UrlEscapeW(
* *
* Converts escape sequences back to ordinary characters. * Converts escape sequences back to ordinary characters.
* *
* If URL_ESCAPE_INPLACE is set in dwFlags then pszUnescaped and * PARAMS
* pcchUnescaped are ignored and the converted string is returned in * pszUrl [I/O] Url to convert
* pszUrl, otherwise the string is returned in pszUnescaped. * pszUnescaped [O] Destination for converted Url
* pcchUnescaped should contain the size of pszUnescaped on calling * pcchUnescaped [I/O] Size of output string
* and will contain the length the the returned string on return if * dwFlags [I] URL_ESCAPE_ Flags from "shlwapi.h"
* the buffer is big enough else it will contain the buffer size
* required (including room for the '\0'). The function returns S_OK
* on success or E_POINTER if the buffer is not large enough. If the
* URL_DONT_ESCAPE_EXTRA_INFO flag is set then the conversion stops at
* the first occurrence of either '?' or '#'.
* *
* RETURNS
* Success: S_OK. The converted value is in pszUnescaped, or in pszUrl if
* dwFlags includes URL_ESCAPE_INPLACE.
* Failure: E_POINTER if the converted Url is bigger than pcchUnescaped. In
* this case pcchUnescaped is set to the size required.
* NOTES
* If dwFlags includes URL_DONT_ESCAPE_EXTRA_INFO, the conversion stops at
* the first occurrence of either '?' or '#'.
*/ */
HRESULT WINAPI UrlUnescapeA( HRESULT WINAPI UrlUnescapeA(
LPCSTR pszUrl, LPCSTR pszUrl,
@ -1146,7 +1167,7 @@ HRESULT WINAPI UrlUnescapeA(
/************************************************************************* /*************************************************************************
* UrlUnescapeW [SHLWAPI.@] * UrlUnescapeW [SHLWAPI.@]
* *
* See UrlUnescapeA for list of assumptions, bugs, and FIXMEs * See UrlUnescapeA.
*/ */
HRESULT WINAPI UrlUnescapeW( HRESULT WINAPI UrlUnescapeW(
LPCWSTR pszUrl, LPCWSTR pszUrl,
@ -1210,21 +1231,31 @@ HRESULT WINAPI UrlUnescapeW(
/************************************************************************* /*************************************************************************
* UrlGetLocationA [SHLWAPI.@] * UrlGetLocationA [SHLWAPI.@]
* *
* Bugs/Features: * Get the location from a Url.
*
* PARAMS
* pszUrl [I] Url to get the location from
*
* RETURNS
* A pointer to the start of the location in pszUrl, or NULL if there is
* no location.
*
* NOTES
* MSDN (as of 2001-11-01) says that: * MSDN (as of 2001-11-01) says that:
* "The location is the segment of the URL starting with a ? * "The location is the segment of the URL starting with a ?
* or # character." * or # character."
* Neither V4 nor V5 of shlwapi.dll implement the '?' and always return * Neither V4 nor V5 of shlwapi.dll implement the '?' and always return
* a NULL. * a NULL.
*
* MSDN further states that: * MSDN further states that:
* "If a file URL has a query string, the returned string is * "If a file URL has a query string, the returned string is
* the query string." * the query string."
* In all test cases if the scheme starts with "fi" then a NULL is * In all test cases if the scheme starts with "fi" then a NULL is
* returned. V5 gives the following results: * returned. V5 gives the following results:
* NULL file://aa/b/cd#hohoh *| NULL file://aa/b/cd#hohoh
* #hohoh http://aa/b/cd#hohoh *| #hohoh http://aa/b/cd#hohoh
* NULL fi://aa/b/cd#hohoh *| NULL fi://aa/b/cd#hohoh
* #hohoh ff://aa/b/cd#hohoh *| #hohoh ff://aa/b/cd#hohoh
*/ */
LPCSTR WINAPI UrlGetLocationA( LPCSTR WINAPI UrlGetLocationA(
LPCSTR pszUrl) LPCSTR pszUrl)
@ -1246,7 +1277,7 @@ LPCSTR WINAPI UrlGetLocationA(
/************************************************************************* /*************************************************************************
* UrlGetLocationW [SHLWAPI.@] * UrlGetLocationW [SHLWAPI.@]
* *
* See UrlGetLocationA for list of assumptions, bugs, and FIXMEs * See UrlGetLocationA.
*/ */
LPCWSTR WINAPI UrlGetLocationW( LPCWSTR WINAPI UrlGetLocationW(
LPCWSTR pszUrl) LPCWSTR pszUrl)
@ -1319,6 +1350,16 @@ INT WINAPI UrlCompareW(
* HashData [SHLWAPI.@] * HashData [SHLWAPI.@]
* *
* Hash an input block into a variable sized digest. * Hash an input block into a variable sized digest.
*
* PARAMS
* lpSrc [I] Input block
* nSrcLen [I] Length of lpSrc
* lpDest [I] Output for hash digest
* nDestLen [I] Length of lpDest
*
* RETURNS
* Success: TRUE. lpDest is filled with the computed hash value.
* Failure: FALSE, if any argument is invalid.
*/ */
BOOL WINAPI HashData(const unsigned char *lpSrc, INT nSrcLen, BOOL WINAPI HashData(const unsigned char *lpSrc, INT nSrcLen,
unsigned char *lpDest, INT nDestLen) unsigned char *lpDest, INT nDestLen)
@ -1351,7 +1392,16 @@ BOOL WINAPI HashData(const unsigned char *lpSrc, INT nSrcLen,
/************************************************************************* /*************************************************************************
* UrlHashA [SHLWAPI.@] * UrlHashA [SHLWAPI.@]
* *
* Hash an ASCII URL. * Produce a Hash from a Url.
*
* PARAMS
* pszUrl [I] Url to hash
* lpDest [O] Destinationh for hash
* nDestLen [I] Length of lpDest
*
* RETURNS
* Success: S_OK. lpDest is filled with the computed hash value.
* Failure: E_INVALIDARG, if any argument is invalid.
*/ */
HRESULT WINAPI UrlHashA(LPCSTR pszUrl, unsigned char *lpDest, INT nDestLen) HRESULT WINAPI UrlHashA(LPCSTR pszUrl, unsigned char *lpDest, INT nDestLen)
{ {
@ -1420,7 +1470,7 @@ HRESULT WINAPI UrlApplySchemeA(LPCSTR pszIn, LPSTR pszOut, LPDWORD pcchOut, DWOR
return ret; return ret;
} }
HRESULT URL_GuessScheme(LPCWSTR pszIn, LPWSTR pszOut, LPDWORD pcchOut) static HRESULT URL_GuessScheme(LPCWSTR pszIn, LPWSTR pszOut, LPDWORD pcchOut)
{ {
HKEY newkey; HKEY newkey;
BOOL j; BOOL j;
@ -1564,6 +1614,16 @@ HRESULT WINAPI UrlApplySchemeW(LPCWSTR pszIn, LPWSTR pszOut, LPDWORD pcchOut, DW
/************************************************************************* /*************************************************************************
* UrlIsA [SHLWAPI.@] * UrlIsA [SHLWAPI.@]
*
* Determine if a Url is of a certain class.
*
* PARAMS
* pszUrl [I] Url to check
* Urlis [I] URLIS_ constant from "shlwapi.h"
*
* RETURNS
* TRUE if pszUrl belongs to the class type in Urlis.
* FALSE Otherwise.
*/ */
BOOL WINAPI UrlIsA(LPCSTR pszUrl, URLIS Urlis) BOOL WINAPI UrlIsA(LPCSTR pszUrl, URLIS Urlis)
{ {
@ -1595,6 +1655,8 @@ BOOL WINAPI UrlIsA(LPCSTR pszUrl, URLIS Urlis)
/************************************************************************* /*************************************************************************
* UrlIsW [SHLWAPI.@] * UrlIsW [SHLWAPI.@]
*
* See UrlIsA.
*/ */
BOOL WINAPI UrlIsW(LPCWSTR pszUrl, URLIS Urlis) BOOL WINAPI UrlIsW(LPCWSTR pszUrl, URLIS Urlis)
{ {
@ -1642,6 +1704,18 @@ BOOL WINAPI UrlIsNoHistoryW(LPCWSTR pszUrl)
/************************************************************************* /*************************************************************************
* UrlIsOpaqueA [SHLWAPI.@] * UrlIsOpaqueA [SHLWAPI.@]
*
* Determine if a Url is opaque.
*
* PARAMS
* pszUrl [I] Url to check
*
* RETURNS
* TRUE if pszUrl is opaque,
* FALSE Otherwise.
*
* NOTES
* An opaque Url is one that does not start with "<protocol>://".
*/ */
BOOL WINAPI UrlIsOpaqueA(LPCSTR pszUrl) BOOL WINAPI UrlIsOpaqueA(LPCSTR pszUrl)
{ {
@ -1650,6 +1724,8 @@ BOOL WINAPI UrlIsOpaqueA(LPCSTR pszUrl)
/************************************************************************* /*************************************************************************
* UrlIsOpaqueW [SHLWAPI.@] * UrlIsOpaqueW [SHLWAPI.@]
*
* See UrlIsOpaqueA.
*/ */
BOOL WINAPI UrlIsOpaqueW(LPCWSTR pszUrl) BOOL WINAPI UrlIsOpaqueW(LPCWSTR pszUrl)
{ {
@ -1662,7 +1738,7 @@ BOOL WINAPI UrlIsOpaqueW(LPCWSTR pszUrl)
* *
* Characters tested based on RFC 1738 * Characters tested based on RFC 1738
*/ */
LPCWSTR URL_ScanID(LPCWSTR start, LPDWORD size, WINE_URL_SCAN_TYPE type) static LPCWSTR URL_ScanID(LPCWSTR start, LPDWORD size, WINE_URL_SCAN_TYPE type)
{ {
static DWORD alwayszero = 0; static DWORD alwayszero = 0;
BOOL cont = TRUE; BOOL cont = TRUE;
@ -1757,7 +1833,7 @@ LPCWSTR URL_ScanID(LPCWSTR start, LPDWORD size, WINE_URL_SCAN_TYPE type)
/************************************************************************* /*************************************************************************
* Attempt to parse URL into pieces. * Attempt to parse URL into pieces.
*/ */
LONG URL_ParseUrl(LPCWSTR pszUrl, WINE_PARSE_URL *pl) static LONG URL_ParseUrl(LPCWSTR pszUrl, WINE_PARSE_URL *pl)
{ {
LPCWSTR work; LPCWSTR work;
@ -1968,6 +2044,8 @@ BOOL WINAPI PathIsURLA(LPCSTR lpstrPath)
/************************************************************************* /*************************************************************************
* PathIsURLW [SHLWAPI.@] * PathIsURLW [SHLWAPI.@]
*
* See PathIsURLA.
*/ */
BOOL WINAPI PathIsURLW(LPCWSTR lpstrPath) BOOL WINAPI PathIsURLW(LPCWSTR lpstrPath)
{ {
@ -1984,6 +2062,18 @@ BOOL WINAPI PathIsURLW(LPCWSTR lpstrPath)
/************************************************************************* /*************************************************************************
* UrlCreateFromPathA [SHLWAPI.@] * UrlCreateFromPathA [SHLWAPI.@]
*
* Create a Url from a file path.
*
* PARAMS
* pszPath [I] Path to convert
* pszUrl [O] Destination for the converted Url
* pcchUrl [I/O] Length of pszUrl
* dwReserved [I] Reserved, must be 0
*
* RETURNS
* Success: S_OK. pszUrl contains the converted path.
* Failure: An HRESULT error code.
*/ */
HRESULT WINAPI UrlCreateFromPathA(LPCSTR pszPath, LPSTR pszUrl, LPDWORD pcchUrl, DWORD dwReserved) HRESULT WINAPI UrlCreateFromPathA(LPCSTR pszPath, LPSTR pszUrl, LPDWORD pcchUrl, DWORD dwReserved)
{ {
@ -2088,7 +2178,9 @@ HRESULT WINAPI UrlCreateFromPathA(LPCSTR pszPath, LPSTR pszUrl, LPDWORD pcchUrl,
} }
/************************************************************************* /*************************************************************************
* UrlCreateFromPathA [SHLWAPI.@] * UrlCreateFromPathW [SHLWAPI.@]
*
* See UrlCreateFromPathA.
*/ */
HRESULT WINAPI UrlCreateFromPathW(LPCWSTR pszPath, LPWSTR pszUrl, LPDWORD pcchUrl, DWORD dwReserved) HRESULT WINAPI UrlCreateFromPathW(LPCWSTR pszPath, LPWSTR pszUrl, LPDWORD pcchUrl, DWORD dwReserved)
{ {

26
dlls/shlwapi/wsprintf.c
View File

@ -271,6 +271,17 @@ static UINT WPRINTF_GetLen( WPRINTF_FORMAT *format, WPRINTF_DATA *arg,
/*********************************************************************** /***********************************************************************
* wvnsprintfA (SHLWAPI.@) * wvnsprintfA (SHLWAPI.@)
*
* Print formatted output to a string, up to a maximum number of chars.
*
* PARAMS
* lpOut [O] Destination for output string
* cchLimitIn [I] Maximum number of characters to write
* lpFmt [I] Format string
*
* RETURNS
* Success: The number of characters written.
* Failure: -1.
*/ */
INT WINAPI wvnsprintfA( LPSTR buffer, UINT maxlen, LPCSTR spec, va_list args ) INT WINAPI wvnsprintfA( LPSTR buffer, UINT maxlen, LPCSTR spec, va_list args )
{ {
@ -374,6 +385,8 @@ INT WINAPI wvnsprintfA( LPSTR buffer, UINT maxlen, LPCSTR spec, va_list args )
/*********************************************************************** /***********************************************************************
* wvnsprintfW (SHLWAPI.@) * wvnsprintfW (SHLWAPI.@)
*
* See wvnsprintfA.
*/ */
INT WINAPI wvnsprintfW( LPWSTR buffer, UINT maxlen, LPCWSTR spec, va_list args ) INT WINAPI wvnsprintfW( LPWSTR buffer, UINT maxlen, LPCWSTR spec, va_list args )
{ {
@ -476,6 +489,17 @@ INT WINAPI wvnsprintfW( LPWSTR buffer, UINT maxlen, LPCWSTR spec, va_list args )
/************************************************************************* /*************************************************************************
* wnsprintfA (SHLWAPI.@) * wnsprintfA (SHLWAPI.@)
*
* Print formatted output to a string, up to a maximum number of chars.
*
* PARAMS
* lpOut [O] Destination for output string
* cchLimitIn [I] Maximum number of characters to write
* lpFmt [I] Format string
*
* RETURNS
* Success: The number of characters written.
* Failure: -1.
*/ */
int WINAPIV wnsprintfA(LPSTR lpOut, int cchLimitIn, LPCSTR lpFmt, ...) int WINAPIV wnsprintfA(LPSTR lpOut, int cchLimitIn, LPCSTR lpFmt, ...)
{ {
@ -491,6 +515,8 @@ int WINAPIV wnsprintfA(LPSTR lpOut, int cchLimitIn, LPCSTR lpFmt, ...)
/************************************************************************* /*************************************************************************
* wnsprintfW (SHLWAPI.@) * wnsprintfW (SHLWAPI.@)
*
* See wnsprintfA.
*/ */
int WINAPIV wnsprintfW(LPWSTR lpOut, int cchLimitIn, LPCWSTR lpFmt, ...) int WINAPIV wnsprintfW(LPWSTR lpOut, int cchLimitIn, LPCWSTR lpFmt, ...)
{ {

75
dlls/urlmon/umon.c
View File

@ -1,13 +1,9 @@
/* /*
* UrlMon * UrlMon
* *
* Copyright 1999 Corel Corporation * Copyright 1999 Ulrich Czekalla for Corel Corporation
*
* Ulrich Czekalla
*
* Copyright 2002 Huw D M Davies for CodeWeavers * Copyright 2002 Huw D M Davies for CodeWeavers
* *
*
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either * License as published by the Free Software Foundation; either
@ -806,8 +802,10 @@ static HRESULT WINAPI URLMonikerImpl_IBinding_Suspend(IBinding* iface)
/*********************************************************************** /***********************************************************************
* CreateAsyncBindCtxEx (URLMON.@) * CreateAsyncBindCtxEx (URLMON.@)
* *
* not implemented * Create an asynchronous bind context.
* *
* FIXME
* Not implemented.
*/ */
HRESULT WINAPI CreateAsyncBindCtxEx(IBindCtx *ibind, DWORD options, HRESULT WINAPI CreateAsyncBindCtxEx(IBindCtx *ibind, DWORD options,
IBindStatusCallback *callback, IEnumFORMATETC *format, IBindCtx** pbind, IBindStatusCallback *callback, IEnumFORMATETC *format, IBindCtx** pbind,
@ -821,13 +819,17 @@ HRESULT WINAPI CreateAsyncBindCtxEx(IBindCtx *ibind, DWORD options,
/*********************************************************************** /***********************************************************************
* CreateURLMoniker (URLMON.@) * CreateURLMoniker (URLMON.@)
* *
* Create a url moniker * Create a url moniker.
*
* PARAMS
* pmkContext [I] Context
* szURL [I] Url to create the moniker for
* ppmk [O] Destination for created moniker.
* *
* RETURNS * RETURNS
* S_OK success * Success: S_OK. ppmk contains the created IMoniker object.
* E_OUTOFMEMORY out of memory * Failure: MK_E_SYNTAX if szURL is not a valid url, or
* MK_E_SYNTAX not a valid url * E_OUTOFMEMORY if memory allocation fails.
*
*/ */
HRESULT WINAPI CreateURLMoniker(IMoniker *pmkContext, LPCWSTR szURL, IMoniker **ppmk) HRESULT WINAPI CreateURLMoniker(IMoniker *pmkContext, LPCWSTR szURL, IMoniker **ppmk)
{ {
@ -855,13 +857,18 @@ HRESULT WINAPI CreateURLMoniker(IMoniker *pmkContext, LPCWSTR szURL, IMoniker **
/*********************************************************************** /***********************************************************************
* CoInternetGetSession (URLMON.@) * CoInternetGetSession (URLMON.@)
* *
* Creates a session and returns a pointer to an InternetSession interface. * Create a new internet session and return an IInternetSession interface
* representing it.
*
* PARAMS
* dwSessionMode [I] Mode for the internet session
* ppIInternetSession [O] Destination for creates IInternetSession object
* dwReserved [I] Reserved, must be 0.
* *
* RETURNS * RETURNS
* S_OK success * Success: S_OK. ppIInternetSession contains the IInternetSession interface.
* E_OUTOFMEMORY out of memory * Failure: E_INVALIDARG, if any argument is invalid, or
* E_INVALIDARG invalid argument * E_OUTOFMEMORY if memory allocation fails.
*
*/ */
HRESULT WINAPI CoInternetGetSession(DWORD dwSessionMode, /*IInternetSession*/void **ppIInternetSession, DWORD dwReserved) HRESULT WINAPI CoInternetGetSession(DWORD dwSessionMode, /*IInternetSession*/void **ppIInternetSession, DWORD dwReserved)
{ {
@ -916,13 +923,18 @@ HRESULT WINAPI FindMimeFromData(LPBC pBC, LPCWSTR pwzUrl, LPVOID pBuffer,
/*********************************************************************** /***********************************************************************
* RegisterBindStatusCallback (URLMON.@) * RegisterBindStatusCallback (URLMON.@)
* *
* Register a bind status callback * Register a bind status callback.
*
* PARAMS
* pbc [I] Binding context
* pbsc [I] Callback to register
* ppbscPrevious [O] Destination for previous callback
* dwReserved [I] Reserved, must be 0.
* *
* RETURNS * RETURNS
* S_OK success * Success: S_OK.
* E_INVALIDARG invalid argument(s) * Failure: E_INVALIDARG, if any argument is invalid, or
* E_OUTOFMEMORY out of memory * E_OUTOFMEMORY if memory allocation fails.
*
*/ */
HRESULT WINAPI RegisterBindStatusCallback( HRESULT WINAPI RegisterBindStatusCallback(
IBindCtx *pbc, IBindCtx *pbc,
@ -952,13 +964,15 @@ HRESULT WINAPI RegisterBindStatusCallback(
/*********************************************************************** /***********************************************************************
* RevokeBindStatusCallback (URLMON.@) * RevokeBindStatusCallback (URLMON.@)
* *
* Unregister a bind status callback * Unregister a bind status callback.
*
* pbc [I] Binding context
* pbsc [I] Callback to unregister
* *
* RETURNS * RETURNS
* S_OK success * Success: S_OK.
* E_INVALIDARG invalid argument(s) * Failure: E_INVALIDARG, if any argument is invalid, or
* E_FAIL pbsc wasn't registered with pbc * E_FAIL if pbsc wasn't registered with pbc.
*
*/ */
HRESULT WINAPI RevokeBindStatusCallback( HRESULT WINAPI RevokeBindStatusCallback(
IBindCtx *pbc, IBindCtx *pbc,
@ -988,10 +1002,15 @@ HRESULT WINAPI RevokeBindStatusCallback(
/*********************************************************************** /***********************************************************************
* ReleaseBindInfo (URLMON.@) * ReleaseBindInfo (URLMON.@)
* *
* Releases the resources used by the specified BINDINFO structure * Release the resources used by the specified BINDINFO structure.
* *
* PARAMS
* pbindinfo [I] BINDINFO to release.
*
* RETURNS
* Nothing.
*/ */
void WINAPI ReleaseBindInfo(BINDINFO* pbindinfo) void WINAPI ReleaseBindInfo(BINDINFO* pbindinfo)
{ {
FIXME("stub\n"); FIXME("(%p)stub!\n", pbindinfo);
} }

68
dlls/wsock32/service.c
View File

@ -33,15 +33,15 @@ WINE_DEFAULT_DEBUG_CHANNEL(winsock);
/****************************************************************************** /******************************************************************************
* GetTypeByNameA [WSOCK32.1113] * GetTypeByNameA [WSOCK32.1113]
* *
* Retrieves a service type GUID for a network service specified by name * Retrieve a service type GUID for a network service specified by name.
* *
* PARAMETERS * PARAMETERS
* lpServiceName -- Pointer to a zero-terminated ASCII string that uniquely represents the name of the service * lpServiceName [I] NUL-terminated ASCII string that uniquely represents the name of the service
* lpServiceType -- Pointer to a variable to receive a GUID that specifies the type of network service * lpServiceType [O] Destination for the service type GUID
* *
* RETURNS * RETURNS
* Zero on success, SOCKET_ERROR on failure. * Success: 0. lpServiceType contains the requested GUID
* GetLastError can return ERROR_SERVICE_DOES_NOT_EXIST * Failure: SOCKET_ERROR. GetLastError() can return ERROR_SERVICE_DOES_NOT_EXIST
* *
* NOTES * NOTES
* Obsolete Microsoft-specific extension to Winsock 1.1. * Obsolete Microsoft-specific extension to Winsock 1.1.
@ -64,22 +64,7 @@ INT WINAPI GetTypeByNameA(LPSTR lpServiceName, LPGUID lpServiceType)
/****************************************************************************** /******************************************************************************
* GetTypeByNameW [WSOCK32.1114] * GetTypeByNameW [WSOCK32.1114]
* *
* Retrieves a service type GUID for a network service specified by name * See GetTypeByNameA.
*
* PARAMETERS
* lpServiceName -- Pointer to a zero-terminated Unicode string that uniquely represents the name of the service
* lpServiceType -- Pointer to a variable to receive a GUID that specifies the type of network service
*
* RETURNS
* Zero on success, SOCKET_ERROR on failure.
* GetLastError can return ERROR_SERVICE_DOES_NOT_EXIST
*
* NOTES
* Obsolete Microsoft-specific extension to Winsock 1.1.
* Protocol-independent name resolution provides equivalent functionality in Winsock 2.
*
* BUGS
* Unimplemented
*/ */
INT WINAPI GetTypeByNameW(LPWSTR lpServiceName, LPGUID lpServiceType) INT WINAPI GetTypeByNameW(LPWSTR lpServiceName, LPGUID lpServiceType)
{ {
@ -94,22 +79,22 @@ INT WINAPI GetTypeByNameW(LPWSTR lpServiceName, LPGUID lpServiceType)
/****************************************************************************** /******************************************************************************
* SetServiceA [WSOCK32.1117] * SetServiceA [WSOCK32.1117]
* *
* Registers or unregisters a network service with one or more name spaces * Register or unregister a network service with one or more namespaces.
* *
* PARAMETERS * PARAMETERS
* dwNameSpace -- Name space or set of name spaces within which the function will operate * dwNameSpace [I] Name space or set of name spaces within which the function will operate
* dwOperation -- Specifies the operation that the function will perform * dwOperation [I] Operation to perform
* dwFlags -- Set of bit flags that modify the function's operation * dwFlags [I] Flags to modify the function's operation
* lpServiceInfo -- Pointer to a ASCII SERVICE_INFO structure * lpServiceInfo [I] Pointer to a ASCII SERVICE_INFO structure
* lpServiceAsyncInfo -- Reserved for future use. Must be NULL. * lpServiceAsyncInfo [I] Reserved for future use. Must be NULL.
* lpdwStatusFlags -- Set of bit flags that receive function status information * lpdwStatusFlags [O] Destination for function status information
* *
* RETURNS * RETURNS
* SOCKET_ERROR on failure. * Success: 0.
* GetLastError can return ERROR_ALREADY_REGISTERED * Failure: SOCKET_ERROR. GetLastError() can return ERROR_ALREADY_REGISTERED
* *
* NOTES * NOTES
* Obsolete Microsoft-specific extension to Winsock 1.1 * Obsolete Microsoft-specific extension to Winsock 1.1,
* Protocol-independent name resolution provides equivalent functionality in Winsock 2. * Protocol-independent name resolution provides equivalent functionality in Winsock 2.
* *
* BUGS * BUGS
@ -130,26 +115,7 @@ INT WINAPI SetServiceA(DWORD dwNameSpace, DWORD dwOperation, DWORD dwFlags, LPSE
/****************************************************************************** /******************************************************************************
* SetServiceW [WSOCK32.1118] * SetServiceW [WSOCK32.1118]
* *
* Registers or unregisters a network service with one or more name spaces * See SetServiceA.
*
* PARAMETERS
* dwNameSpace -- Name space or set of name spaces within which the function will operate
* dwOperation -- Specifies the operation that the function will perform
* dwFlags -- Set of bit flags that modify the function's operation
* lpServiceInfo -- Pointer to a Unicode SERVICE_INFO structure
* lpServiceAsyncInfo -- Reserved for future use. Must be NULL.
* lpdwStatusFlags -- Set of bit flags that receive function status information
*
* RETURNS
* SOCKET_ERROR on failure.
* GetLastError can return ERROR_ALREADY_REGISTERED
*
* NOTES
* Obsolete Microsoft-specific extension to Winsock 1.1
* Protocol-independent name resolution provides equivalent functionality in Winsock 2.
*
* BUGS
* Unimplemented.
*/ */
INT WINAPI SetServiceW(DWORD dwNameSpace, DWORD dwOperation, DWORD dwFlags, LPSERVICE_INFOW lpServiceInfo, INT WINAPI SetServiceW(DWORD dwNameSpace, DWORD dwOperation, DWORD dwFlags, LPSERVICE_INFOW lpServiceInfo,
LPSERVICE_ASYNC_INFO lpServiceAsyncInfo, LPDWORD lpdwStatusFlags) LPSERVICE_ASYNC_INFO lpServiceAsyncInfo, LPDWORD lpdwStatusFlags)

44
ole/ole2nls.c
View File

@ -583,36 +583,30 @@ static int identity(int c)
* *
* Convert a string, or generate a sort key from it. * Convert a string, or generate a sort key from it.
* *
* If (mapflags & LCMAP_SORTKEY), the function will generate
* a sort key for the source string. Else, it will convert it
* accordingly to the flags LCMAP_UPPERCASE, LCMAP_LOWERCASE,...
*
* RETURNS * RETURNS
* Error : 0. * Success: The length of the string written to dststr.
* Success : length of the result string. * Failure: 0.
* *
* NOTES * NOTES
* If called with scrlen = -1, the function will compute the length * -If mapflags includes LCMAP_SORTKEY, the function will generate a
* of the 0-terminated string strsrc by itself. * sort key for srcstr. Otherwise, srcstr is converted according to
* * mapflags.
* If called with dstlen = 0, returns the buffer length that * -If scrlen is -1, the function will compute the length of strsrc
* would be required. * (which must be NUL terminated) itself.
* * -If dstlen is 0, The return value is the buffer length that is needed.
* NORM_IGNOREWIDTH means to compare ASCII and wide characters * -NORM_IGNOREWIDTH means to compare ASCII and wide characters
* as if they are equal. * as if they are equal.
* In the only code page implemented so far, there may not be * In the only code page implemented so far, there may not be
* wide characters in strings passed to LCMapStringA, * wide characters in strings passed to this function,
* so there is nothing to be done for this flag. * so there is nothing to be done for this flag.
*/ */
INT WINAPI LCMapStringA( INT WINAPI LCMapStringA(
LCID lcid, /* [in] locale identifier created with MAKELCID; LCID lcid, /* [in] Locale Id */
LOCALE_SYSTEM_DEFAULT and LOCALE_USER_DEFAULT are DWORD mapflags, /* [in] Flags */
predefined values. */ LPCSTR srcstr, /* [in] Source buffer */
DWORD mapflags, /* [in] flags */ INT srclen, /* [in] Length of srcstr */
LPCSTR srcstr, /* [in] source buffer */ LPSTR dststr, /* [out] Destination buffer */
INT srclen, /* [in] source length */ INT dstlen) /* [in] Length of dststr */
LPSTR dststr, /* [out] destination buffer */
INT dstlen) /* [in] destination buffer length */
{ {
int i; int i;
@ -844,11 +838,7 @@ INT WINAPI LCMapStringA(
/************************************************************************* /*************************************************************************
* LCMapStringW [KERNEL32.@] * LCMapStringW [KERNEL32.@]
* *
* Convert a string, or generate a sort key from it. * See LCMapStringA.
*
* NOTE
*
* See LCMapStringA for documentation
*/ */
INT WINAPI LCMapStringW( INT WINAPI LCMapStringW(
LCID lcid,DWORD mapflags,LPCWSTR srcstr,INT srclen,LPWSTR dststr, LCID lcid,DWORD mapflags,LPCWSTR srcstr,INT srclen,LPWSTR dststr,

17
windows/dce.c
View File

@ -523,12 +523,15 @@ END:
/*********************************************************************** /***********************************************************************
* GetDC (USER32.@) * GetDC (USER32.@)
*
* Get a device context.
*
* RETURNS * RETURNS
* :Handle to DC * Success: Handle to the device context
* NULL: Failure * Failure: NULL.
*/ */
HDC WINAPI GetDC( HDC WINAPI GetDC(
HWND hwnd /* [in] handle of window */ HWND hwnd /* [in] handle of window - may be NULL */
) { ) {
if (!hwnd) if (!hwnd)
return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW ); return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
@ -548,12 +551,14 @@ HDC WINAPI GetWindowDC( HWND hwnd )
/*********************************************************************** /***********************************************************************
* ReleaseDC (USER32.@) * ReleaseDC (USER32.@)
* *
* Release a device context.
*
* RETURNS * RETURNS
* 1: Success * Success: Non-zero. Resources used by hdc are released.
* 0: Failure * Failure: 0.
*/ */
INT WINAPI ReleaseDC( INT WINAPI ReleaseDC(
HWND hwnd /* [in] Handle of window - ignored */, HWND hwnd, /* [in] Handle of window - ignored */
HDC hdc /* [in] Handle of device context */ HDC hdc /* [in] Handle of device context */
) { ) {
DCE * dce; DCE * dce;