windows.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	HRESULT_GET_ERROR_COMMON(res, errptr)

Enumerations
enum	{ BUILD_WINDOWS_11_OR_LATER = 22000 }

Functions
bool	com_initialize (bool *com_initialized, const char *err_prefix)
void	com_uninitialize (bool *com_initialized)

Detailed Description

Author

Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

Definition in file windows.h.

Macro Definition Documentation

HRESULT_GET_ERROR_COMMON

#define HRESULT_GET_ERROR_COMMON	(		res,
			errptr )

Value:

        switch (res) { \
                case S_OK: errptr = "Operation successful"; break; \
                case S_FALSE: errptr = "Operation completed"; break; \
                case E_NOTIMPL: errptr = "Not implemented"; break; \
                case E_NOINTERFACE: errptr = "No such interface supported"; break; \
                case E_POINTER: errptr = "Pointer that is not valid"; break; \
                case E_ABORT: errptr = "Operation aborted"; break; \
                case E_FAIL: errptr = "Unspecified failure"; break; \
                case E_UNEXPECTED: errptr = "Unexpected failure"; break; \
                case E_ACCESSDENIED: errptr = "General access denied error"; break; \
                case E_HANDLE: errptr = "Handle that is not valid"; break; \
                case E_OUTOFMEMORY: errptr = "Failed to allocate necessary memory"; break; \
                case E_INVALIDARG: errptr = "One or more arguments are not valid"; break; \
        }

this macro is shared between both utils/windows.cpp, where the error codes defines system and bmd_hresult_to_string where only the subset below is defined by LinuxCOM.h compat, so use only values defined in that header.

Definition at line 60 of file windows.h.

#define HRESULT_GET_ERROR_COMMON(res, errptr) \
        switch (res) { \
                case S_OK: errptr = "Operation successful"; break; \
                case S_FALSE: errptr = "Operation completed"; break; \
                case E_NOTIMPL: errptr = "Not implemented"; break; \
                case E_NOINTERFACE: errptr = "No such interface supported"; break; \
                case E_POINTER: errptr = "Pointer that is not valid"; break; \
                case E_ABORT: errptr = "Operation aborted"; break; \
                case E_FAIL: errptr = "Unspecified failure"; break; \
                case E_UNEXPECTED: errptr = "Unexpected failure"; break; \
                case E_ACCESSDENIED: errptr = "General access denied error"; break; \
                case E_HANDLE: errptr = "Handle that is not valid"; break; \
                case E_OUTOFMEMORY: errptr = "Failed to allocate necessary memory"; break; \
                case E_INVALIDARG: errptr = "One or more arguments are not valid"; break; \
        }

Referenced by bmd_hresult_to_string().

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
BUILD_WINDOWS_11_OR_LATER

Definition at line 45 of file windows.h.

     {
        BUILD_WINDOWS_11_OR_LATER = 22000,
};

Function Documentation

com_initialize()

bool com_initialize	(	bool *	com_initialized,
		const char *	err_prefix )

Parameters

	com_initialized	- pointer passed to com_initialize (or create_com_iterator)
[out]	com_initialize	a pointer to a bool that will be passed to com_uninintialize(). The value should be initialized to false - the current logic can guard only one init/uninit so true is assumed bo be a repeated call.
[in]	err_prefix	optional error prefix to be used for eventual error messges (may be NULL)

Return values

true	if either COM already initalized for this thread or this call initializes COM succesfully
false	COM could not have been initialized

Definition at line 65 of file windows.c.

{
        if (*com_initialized) {
                MSG(WARNING, "com_initialized should be initalized to false "
                             "upon the call!\n");
        }
#ifdef _WIN32
        if (err_prefix == NULL) {
                err_prefix = "";
        }
        *com_initialized = false;
        // Initialize COM on this thread
        HRESULT result = CoInitializeEx(NULL, COINIT_MULTITHREADED);
        if (SUCCEEDED(result)) {
                *com_initialized = true;
                return true;
        }
        if (result == RPC_E_CHANGED_MODE) {
                log_msg(LOG_LEVEL_WARNING, "%sCOM already intiialized with a different mode!\n", err_prefix);
                return true;
        }
        log_msg(LOG_LEVEL_ERROR, "%sInitialize of COM failed - %s\n", err_prefix, hresult_to_str(result));
        return false;
#else
        (void) com_initialized, (void) err_prefix;
        return true;
#endif
}

References LOG_LEVEL_ERROR, LOG_LEVEL_WARNING, log_msg(), and MSG.

Referenced by vidcap_decklink_state::vidcap_decklink_state(), audio_cap_wasapi_init(), audio_cap_wasapi_probe(), audio_play_wasapi_help(), audio_play_wasapi_init(), audio_play_wasapi_probe(), blackmagic_api_version_check(), common_init(), common_preinit(), create_decklink_iterator(), print_decklink_version(), and show_help().

Here is the call graph for this function:

com_uninitialize()

void com_uninitialize

(

bool *

com_initialized

)

Definition at line 94 of file windows.c.

{
#ifdef _WIN32
        if (!*com_initialized) {
                return;
        }
        *com_initialized = false;
        CoUninitialize();
#else
        (void) com_initialized;
#endif
}

Referenced by vidcap_decklink_state::~vidcap_decklink_state(), audio_cap_wasapi_probe(), audio_play_wasapi_help(), audio_play_wasapi_init(), audio_play_wasapi_probe(), cleanup(), common_cleanup(), decklink_uninitialize(), print_decklink_version(), and show_help().