[wintrust] Add some documentation

Paul Vriens Paul.Vriens at xs4all.nl
Tue Aug 29 11:11:17 CDT 2006


Hi,

I thought I'd start with some documentation. The tests are already
there so what's missing is the implementation :-).

Changelog
  Add some documentation

Cheers,

Paul.
---
 dlls/wintrust/register.c |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/dlls/wintrust/register.c b/dlls/wintrust/register.c
index 928d9e9..7022e8b 100644
--- a/dlls/wintrust/register.c
+++ b/dlls/wintrust/register.c
@@ -34,6 +34,23 @@ WINE_DEFAULT_DEBUG_CHANNEL(wintrust);
 
 /***********************************************************************
  *		WintrustAddActionID (WINTRUST.@)
+ *
+ * Add a Trust provider. Or actually the functions it performs.
+ *
+ * PARAMS
+ *   pgActionID [I] Pointer to a GUID for the Trust provider.
+ *   fdwFlags   [I] Flag to indicate whether registry errors are passed on.
+ *   psProvInfo [I] Pointer to a structure with information about DLL name and functions.
+ *
+ * RETURNS
+ *   Success: TRUE.
+ *   Failure: FALSE. (Use GetLastError() for more information)
+ *
+ * NOTES
+ *   Adding a Trust provider is basically only adding relevant information
+ *   to the registry. No verification takes places whether a DLL or it's
+ *   entrypoints exist.
+ *   Information in the registry will always be overwritten.
  */
 BOOL WINAPI WintrustAddActionID( GUID* pgActionID, DWORD fdwFlags,
                                  CRYPT_REGISTER_ACTIONID* psProvInfo)
@@ -45,6 +62,20 @@ BOOL WINAPI WintrustAddActionID( GUID* p
 
 /***********************************************************************
  *              WintrustRemoveActionID (WINTRUST.@)
+ *
+ * Removes a Trust provider. Or actually the functions it performs.
+ *
+ * PARAMS
+ *   pgActionID [I] Pointer to a GUID for the Trust provider.
+ *
+ * RETURNS
+ *   Success: TRUE. (Use GetLastError() for more information)
+ *   Failure: FALSE. (Use GetLastError() for more information)
+ *
+ * NOTES
+ *   Testing shows that WintrustRemoveActionID always return TRUE and that
+ *   a possible error can be retrieved via GetLastError().
+ *   There a no checks if information is in the registry or not.
  */
 BOOL WINAPI WintrustRemoveActionID( GUID* pgActionID )
 {
-- 
1.4.1.1




More information about the wine-patches mailing list