RegSvr32 exit codes documentation?

Question

I played with RegSvr32.exe to register a COM Server and got next exit codes:

0 - when registering properly normal DLL Com Server

3 - when try registering fake DLL Com Server (simple text file renamed to .DLL

4 - when try registering simple DLL, not Com Server

Question: where I can find official (or non-official but good) description of all possible exit codes and their meaning?

Search on internet didn't give me result, on SO I found this topic where is written that exit codes are the same with windows system error code, but I didn't understand why then when try registering bad file I am obtaining code = 3 = ERROR_PATH_NOT_FOUND, and when registering non-COM DLL - 4 = ERROR_TOO_MANY_OPEN_FILES? For me it doesn't sound logically.

Answer 1

The exit codes are not documented. The documentation is here:

• https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/regsvr32

However, the source code for a version REGSVR32.EXE is shipped with Visual Studio 2008. This gives its version as 4.0.0, so is not the same as the one shipped with windows, which reports version 6.

• http://msdn.microsoft.com/en-us/library/ms177531(v=vs.90).aspx

A quick look shows these:

#define FAIL_ARGS   1 // Invalid Argument
#define FAIL_OLE    2 // OleInitialize Failed
#define FAIL_LOAD   3 // LoadLibrary Failed
#define FAIL_ENTRY  4 // GetProcAddress failed
#define FAIL_REG    5 // DllRegisterServer or DllUnregisterServer failed.

Reading the source code suggests that under no circumstances does it return any other code than the ones above and zero for success, which proves it isn't the same as the Windows one.

I suspect that the difference in return codes is if it gets as far as GetProcAddress, it then returns the exit code from the function it calls, instead of just always returning 5.

Ideally they would have made it use GetLastError to get a more useful exit code, but I suspect there are too many tools (e.g. third party install programs) which now depend on exit codes 2-4, and it is too late to change it.

Also see What do the various regsvr32 exit codes mean? on Raymond Chen's blog on MSDN.

Answer 2

Visual Studio used to ship with a MFC sample that was actually the source for the RegSvr32 utility and I remember going through that to harvest the exit codes:

FAIL_ARGS   1
FAIL_OLE    2
FAIL_LOAD   3
FAIL_ENTRY  4  // Not ERROR_TOO_MANY_OPEN_FILES but as expected "could not resolve 
               // DLLRegisterServer" as your using an invalid DLL
FAIL_REG    5

I can't find the sample, but if I Google for what I extracted there is this: http://web.archive.org/web/20140803013714/http://support.microsoft.com:80/kb/207132 which has matching codes so it looks like that KB demo code was also taken from RegSvr. Its trivial to work out the reasons behind each of the failure codes.

Answer 3

Ben's answer is correct, though, do take note that error code 3 is also given as a result if

• the .DLL could not be found
• the .DLL was locked by another process and could not be read
• the process had insufficient rights to open the file. Eg, not running with admin rights when needed (with specific files or common files on the C drive)

> #define FAIL_LOAD 3 // LoadLibrary Failed

Feels a little bit vague, but the LoadLibrary is meant as DLLs referred within the specific DLL. Using an application such as Depends, you can find all references, including missing ones. Take note that a missing reference does not always result an error code 3 (in cases where the DLL actually didn't use it)