COM 프로그래밍에서 HRESULT 타입의 S_FALSE는 실패일까요? 성공일까요?
결론부터 말하면 HRESULT 타입의 S_FALSE 반환값은 성공에 해당합니다. 확인을 위해 다음과 같이 간단하게 코드를 작성할 수 있습니다.
#include "stdafx.h"
int _tmain(int argc, _TCHAR* argv[])
{
HRESULT hr = S_FALSE;
printf("SUCCEEDED == %d\n", SUCCEEDED(hr)); // 출력값: 1
return 0;
}
SUCCEEDED 매크로의 정의를 보면 확실히 알 수 있는데요.
#define SUCCEEDED(hr) (((HRESULT)(hr)) >= 0)
0 이상의 값이면 True라는 의미인데,
#define S_OK 0x0
#define S_FALSE 0x1
과 같은 식으로 값이 할당되어 있기 때문에 S_OK와 S_FALSE는 모두 SUCCEEDED 매크로에 대해 True 값을 반환하게 됩니다. 실제로 이에 대해 마이크로소프트 측의 공식 문서에서도 언급하고 있습니다.
Error Handling in COM
; https://docs.microsoft.com/en-us/windows/win32/learnwin32/error-handling-in-com
그럼 의문을 가질 수 있는 부분이 있는데, 그렇다면 실패한 경우의 일반적인 값으로 S_FALSE 대신 어떤 것을 반환해야 할 것인가? 하는 문제가 남습니다. 그럴 때는 E_FAIL 같은 값을 사용하면 됩니다.
#define E_FAIL 0x80004005
0x8...로 시작하기 때문에 최상위 비트가 1이고 이 때문에 HRESULT 타입에서는 음수값으로 표현됩니다.
처음에는 저도 이런 정책에 대해 이해를 할 수 없었는데 "
Error Handling in COM" 문서의 다음 글을 읽고 그나마 수긍하게 되었습니다.
For example, the CoInitializeEx function returns S_FALSE if you call it a second time from the same thread.
사실, 이게 문제가 되는 경우가 있었는데요.
ICorProfilerInfo *ptr = ...;
IUnknown *pOut = nullptr;
HRESULT hr = ptr->GetModuleMetaData(moduleId, ..., &pOut);
if (FAILED(hr) == TRUE)
{
return;
}
// 이하, GetModuleMetaData 호출이 성공했으므로 pOut 인터페이스 사용하는 코드 작성
저렇게 작성한 코드에서 간혹 가다가 프로세스 비정상 종료 현상이 발생한 것입니다. (현실적으로, 그 많은 코드 중에 잘 실행되지도 않던 저 부분에 문제가 있다는 것을 알게 되기까지는 제법 시간이 걸렸습니다. ^^;)
알고 보니, 가끔씩 S_FALSE 값이 반환되는 경우가 있었고 그럴 때 pOut은 nullptr 였는데 이 상태에서 사용을 하다 보니 비정상 종료가 발생한 것입니다. 그런데 왜? S_FALSE 값을 반환했느냐가 궁금해졌는데, 문서를 찾아보니 해답이 나왔습니다.
ICorProfilerInfo::GetModuleMetaData Method
; https://docs.microsoft.com/en-us/dotnet/framework/unmanaged-api/profiling/icorprofilerinfo-getmodulemetadata-method
Some modules (such as resource modules) have no metadata. In those cases, GetModuleMetaData will return an HRESULT value of S_FALSE, and a null in *ppOut.
즉, 전달된 .NET 모듈 식별자(moduleId)가 메타데이터를 가지고 있지 않은 경우에는 S_FALSE를 반환한 것입니다. 일면 이해가 됩니다. 닷넷의 경우 사용자가 만든 대부분의 모듈은 메타데이터를 가지고 있지만, 간혹 마이크로소프트가 만든 것은 다중 모듈로 분리된 어셈블리를 형성하고 있기 때문에 이런 경우가 발생합니다. (결국 그런 상황이 겹쳐서 프로세스 비정상 종료가 일정한 규칙을 갖지 않고 발생하게 된 원인이 되어 더욱 문제 해결에 애를 먹었습니다.)
휴~~~ 암튼, 이래서 문서를 꼭 봐야 한다는!
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]