How can I get the error message that occurs in the Draw method?

Question

How can I get the error message that occurs in the Draw method?

CDev-8220 470

An error has occurred between BeginDraw, and EndDraw.

How do I get the error, or where it occurred.

I tried using EndDraw(&tag1, &tag2); and GetTags(&tag1, &tag2);, but I don't really know how to get the actual message from these.

Minxin Yu 13,506 Reputation points Microsoft External Staff

2023-08-23T01:46:32.49+00:00

Do you mean ID2D1RenderTarget::BeginDraw?
Castorix31 91,506 Reputation points

2023-08-23T11:33:42.89+00:00

Direct2D Debug Layer
CDev-8220 470 Reputation points

2023-08-26T00:54:47.9633333+00:00

Do you mean ID2D1RenderTarget::BeginDraw?

Not necessarily. I believe I am using D2DDeviceContext.

Direct2D Debug Layer

Is there an alternative?

Answer accepted by question author

2 additional answers

Your answer

Minxin Yu 13,506 Reputation points Microsoft External Staff

2023-08-23T01:46:32.49+00:00

Do you mean ID2D1RenderTarget::BeginDraw?
Castorix31 91,506 Reputation points

2023-08-23T11:33:42.89+00:00

Direct2D Debug Layer
CDev-8220 470 Reputation points

2023-08-26T00:54:47.9633333+00:00

Do you mean ID2D1RenderTarget::BeginDraw?

Not necessarily. I believe I am using D2DDeviceContext.

Direct2D Debug Layer

Is there an alternative?

Answer 1

Castorix31 91,506

I don't see why you cannot use the Direct2D Debug Layer, because it gives useful and detailed errors information

But if you just want the message strings, you don't have to hardcode strings as they are in DLLs and you can call FormatMessage :

            WCHAR wsError[255] = L"", wsErrorMessage[255] = L"";
            // Test random errors
            //int nError = D2DERR_RECREATE_TARGET;
            int nError = D2DERR_UNSUPPORTED_VERSION;           
            GetErrorMessage(nError, NULL, wsErrorMessage);
            wsprintf(wsError, L"Error : %s\n", wsErrorMessage);
            MessageBox(NULL, wsError, L"Error", MB_OK | MB_ICONSTOP);

with :

void GetErrorMessage(DWORD nError, HMODULE hModule, __out_opt LPWSTR wszMessage)
{
    LPVOID lpMsgBuf = NULL;
    DWORD nFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
    if (hModule)
        nFlags |= FORMAT_MESSAGE_FROM_HMODULE;
    FormatMessage(nFlags, hModule,
        (HRESULT_FACILITY(nError) == FACILITY_WIN32) ? HRESULT_CODE(nError) : nError,
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
        (LPWSTR)&lpMsgBuf, 0, NULL);
    if (lpMsgBuf != NULL)
    {
        wsprintf(wszMessage, TEXT("%s"), (LPWSTR)lpMsgBuf);
        LocalFree(lpMsgBuf);
    }
}

CDev-8220 470 Reputation points

2023-09-03T23:17:44.07+00:00

I don't see why you cannot use the Direct2D Debug Layer

Sure you can, since everyone can't use it.

How does your code work?

wsError does not collect anything.

GetErrorMessage has an unknown parameter, and has no filled function.

I don't know what to do with it, but thanks.
Castorix31 91,506 Reputation points

2023-09-04T06:05:08.6133333+00:00

Did you test it ?

The first parameter is the message number

In the test I set D2DERR_UNSUPPORTED_VERSION or D2DERR_RECREATE_TARGET and I get the message for those errors

CDev-8220 470

Did you test it ?

err1

No function. I created a function.

static void GetErrorMessage(const int& err, string str, WCHAR* wsErr) {

	///* convert from wide char to narrow char array */
	//char ch[255];
	//char DefChar = ' ';
	//WideCharToMultiByte(CP_ACP, 0, wsErr, -1, ch, 255, &DefChar, NULL);

	///* A std:string  using the char* constructor. */
	//string ss(ch); 
}

err2

No end to the squiggly lines, but gave it a run.

err3

It has problems.

CDev-8220 470 Reputation points

2023-09-04T18:01:06.9366667+00:00

Removed comment.

CDev-8220 470

I don't get errors with this code.


static string WStringToString(const wstring& wstr, string& str)
{
	size_t size;
	str.resize(wstr.length());
	wcstombs_s(&size, &str[0], str.size() + 1, wstr.c_str(), wstr.size());

	return str;
}

static string GetErrorMessage(const int& err, WCHAR* wsErr) {

	wstring ws(wsErr);
	PCWSTR pcws = ws.c_str();
	wstring wsp(pcws);
	string str = "";
	errStr = WStringToString(wsp, str);

	WCHAR* errorMsg = reinterpret_cast<WCHAR*>(&errStr);
	MessageBox(NULL, errorMsg, L"Error", MB_OK | MB_ICONSTOP);

	return errStr;
}


	if (hr == D2DERR_UNSUPPORTED_VERSION) {
		nError = D2DERR_UNSUPPORTED_VERSION;
	}
	else if (hr == D2DERR_RECREATE_TARGET) {
		nError = D2DERR_RECREATE_TARGET;
	}

	string s = GetErrorMessage(nError, wsErrorMessage);

However, I don't get any message out of it, either.

Castorix31 91,506 Reputation points

2023-09-04T19:05:14.43+00:00

This has no sense : you created another function instead of copying/pasting the function I posted (that I use for decades with some variations...), by removing FormatMessage (!) which is the main API which translates an error message into a message string...
CDev-8220 470 Reputation points

2023-09-04T22:29:54.36+00:00

I did not copy paste the function? How did I get the error, if I did not copy paste the function?

I'm not a brilliant programmer like yourself, so as to expertly know exactly where I should have copy pasted it, so that no errors occur.

That's why I am here at FAQ & Help.

Castorix31 91,506

Your code :

static string GetErrorMessage(const int& err, WCHAR* wsErr) {

	wstring ws(wsErr);
	PCWSTR pcws = ws.c_str();
	wstring wsp(pcws);
	string str = "";
	errStr = WStringToString(wsp, str);

	WCHAR* errorMsg = reinterpret_cast<WCHAR*>(&errStr);
	MessageBox(NULL, errorMsg, L"Error", MB_OK | MB_ICONSTOP);

	return errStr;
}

My code :

void GetErrorMessage(DWORD nError, HMODULE hModule, __out_opt LPWSTR wszMessage)
{
    LPVOID lpMsgBuf = NULL;
    DWORD nFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
    if (hModule)
        nFlags |= FORMAT_MESSAGE_FROM_HMODULE;
    FormatMessage(nFlags, hModule,
        (HRESULT_FACILITY(nError) == FACILITY_WIN32) ? HRESULT_CODE(nError) : nError,
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
        (LPWSTR)&lpMsgBuf, 0, NULL);
    if (lpMsgBuf != NULL)
    {
        wsprintf(wszMessage, TEXT("%s"), (LPWSTR)lpMsgBuf);
        LocalFree(lpMsgBuf);
    }
}

CDev-8220 470 Reputation points

2023-09-05T17:49:52.09+00:00
Sorry I did not see your code.

I saw SQL as the language, and did not think to glance at it.

My mistake, I guess.

Did I put everything in the correct place?

static void GetErrorMessage(DWORD nError, HMODULE hModule, __out_opt LPWSTR wszMessage) { LPVOID lpMsgBuf = NULL; DWORD nFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS; if (hModule) { nFlags |= FORMAT_MESSAGE_FROM_HMODULE; } FormatMessage(nFlags, hModule, (HRESULT_FACILITY(nError) == FACILITY_WIN32) ? HRESULT_CODE(nError) : nError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPWSTR)&lpMsgBuf, 0, NULL ); if (lpMsgBuf != NULL) { wsprintf(wszMessage, TEXT("%s"), (LPWSTR)lpMsgBuf); LocalFree(lpMsgBuf); } } hr = rt->EndDraw(); if (SUCCEEDED(hr)) { //..... } else { logErr(hr); // nError = D2DERR_RECREATE_TARGET; nError = D2DERR_UNSUPPORTED_VERSION; // I tried both GetErrorMessage(nError, NULL, wsErrorMessage); text = wsprintf(wsError, L"Error : %s\n", wsErrorMessage); writingString(text); if (showMessageBox) { MessageBox(NULL, wsError, L"Error", MB_OK | MB_ICONSTOP); showMessageBox = false; } }

So, I used your code, and no error or message was shown.

I'm glad it works for you, but it doesn't, for me.

My code however, gives me the error every time.

In that same function, it gives me this error :

ERROR : The object was not in the correct state to process the method

On another occasion, this error was reported.

ERROR : An invalid parameter was passed to the returning function

I could then look for ways to manage these.

I found an example here, for handling invalid parameters.

I'm able to see all my errors.

ERROR : Attempted to create a device with the debug layer enabled and the layer is not installed

ERROR : An event (for example, a power cycle) interrupted the gathering of presentation statistics

That's useful, in knowing what happened, and I can easily locate where in my functions they occur.

If your code does that, and more, it would be good if I got it to work.

Edit:

Actually, I did not allow the Message Box to show.

It does give a message - The requested Direct2D version is not supported.

I'll check the other message.

There has been a Presentation error, is the other one.
Castorix31 91,506 Reputation points

2023-09-05T18:44:54.4333333+00:00
nError = ...

was just a test to check if the function returned the right string for a given error number

Then remove it and pass hr as parameter :

GetErrorMessage(hr, NULL, wsErrorMessage); wsprintf(wsError, L"Error : %s\n", wsErrorMessage); MessageBox(NULL, wsError, L"Error", MB_OK | MB_ICONSTOP);

to get the wsErrorMessage for hr number
CDev-8220 470 Reputation points

2023-09-05T19:56:19.9333333+00:00

pass hr as parameter

That works great. Thanks.

At least it's less code than what I have.
CDev-8220 470 Reputation points

2023-09-06T01:31:27.7633333+00:00

Can I ask a simple off topic question, which might not be worth starting a new thread.

Concerning the use of wsprintf, Microsoft says Do not use. Consider using one of the following functions instead: StringCbPrintf, StringCbPrintfEx, StringCchPrintf, or StringCchPrintfEx. See Security Considerations.

How can I use any one of those, with your code wsprintf(wsError, L"Error : %s\n", wsErrorMessage);

Also, how can I convert that to string format?

Answer 2

Jeanine Zhang-MSFT 11,356 Microsoft External Staff

Hello,

Welcome to Microsoft Q&A!

I tried using EndDraw(&tag1, &tag2); and GetTags(&tag1, &tag2);, Do you mean ID2D1RenderTarget::BeginDraw? Not necessarily.

What do you mean "Not necessarily"? Could you please tell us what are the EndDraw(&tag1, &tag2); and GetTags(&tag1, &tag2);?

As far as I'm concerned, the Draw method in different interfaces has different ways to get the error message. If you want to get the error message that occurs in the Diretc2D, I also suggest you could try to use Direct2D Debug Layer

UPDATE:

So to get the error, we can set a breakpoint, on if (SUCCEEDED(hr)) {}, and take a peek at the message, in the console, or make our own little error message reporter.

Thank you.

Jeanine

If the answer is the right solution, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

CDev-8220 470 Reputation points

2023-08-28T18:05:27.44+00:00

What do you mean "Not necessarily"?

I'm using the device context.

Could you please tell us what are the EndDraw(&tag1, &tag2); and GetTags(&tag1, &tag2);?

What do you mean?

https://learn.microsoft.com/en-us/windows/win32/api/d2d1/nf-d2d1-id2d1rendertarget-enddraw

As far as I'm concerned, the Draw method in different interfaces has different ways to get the error message. If you want to get the error message that occurs in the Diretc2D, I also suggest you could try to use Direct2D Debug Layer

I am unable to use Direct2D Debug Layer.
Jeanine Zhang-MSFT 11,356 Reputation points Microsoft External Staff

2023-08-29T07:50:04.4433333+00:00

If ID2D1RenderTarget::EndDraw method fails, it will return an HRESULT error code and sets tag1 and tag2 to the tags that were active when the error occurred. If the method succeeds, it returns S_OK.
CDev-8220 470 Reputation points

2023-08-30T11:30:36.1066667+00:00

If ID2D1RenderTarget::EndDraw method fails, it will return an HRESULT error code and sets tag1 and tag2 to the tags that were active when the error occurred. If the method succeeds, it returns S_OK.

Yes, as documented.

So to get the error, we can set a breakpoint, on if (SUCCEEDED(hr)) {}, and take a peek at the message, in the console, or make our own little error message reporter.

Thank you.
Jeanine Zhang-MSFT 11,356 Reputation points Microsoft External Staff

2023-08-31T07:50:16.5066667+00:00

Have you got any updates about this issue?
CDev-8220 470 Reputation points

2023-09-04T01:42:02.33+00:00

Have you got any updates about this issue?

My code below works fine. I get a report on what is wrong. Thank you.

Answer 3

// Error Reporter

const string errDesc[47]{
	"The number is invalid",
	"You can't draw with a bitmap that is currently bound as the target bitmap",
	"You can't draw with a bitmap that has the D2D1_BITMAP_OPTIONS_CANNOT_DRAW option",
	"A cycle occurred in the graph",
	"The display format to render is not supported by the hardware device",
	"A valid display state could not be determined",
	"The class ID of the specified effect is not registered by the operating system",
	"The requested size is larger than the guaranteed supported texture size",
	"The brush types are incompatible for the call",
	"The supplied buffer is too small to accommodate the data",
	"The Direct3D device doesn't have sufficient capabilities to perform the requested action",
	"You can't render the graph with the context's current tiling settings",
	"The application should close this instance of Direct2D and restart it as a new process",
	"A call to this method is invalid",
	"A configuration error occurred in the graph",
	"An internal configuration error occurred in the graph",
	"The specified property doesn't exist",
	"You can't set the image as a target because it is either an effect or a bitmap that ...",
	"The application attempted to reuse a layer resource that has not yet been popped off the stack",
	"The requested DX surface size exceeds the maximum texture size",
	"There is no hardware rendering device available for this operation",
	"The specified sub-property doesn't exist",
	"The object has not yet been initialized",
	"The operation failed because the original target isn't currently bound as a target",
	"The operation can't complete while you have outstanding references to the target bitmap",
	"The application attempted to pop a layer off the stack when a clip was at the top, or ...",
	"This error occurs during print control creation (ID2D1Device::CreatePrintControl) to ...",
	"The application called ID2D1PrintControl::AddPage or ID2D1PrintControl::Close after the ...",
	"The application did not pop all clips and layers off the stack, or it attempted to pop too...",
	"A presentation error has occurred that may be recoverable. The caller needs to re-create ...",
	"The requested operation cannot be performed until all layers and clips have been popped ...",
	"The geometry scanner failed to process the data",
	"Direct2D could not access the screen",
	"Shader compilation failed",
	"The render target is not compatible with GDI",
	"A text client drawing effect object is of the wrong type",
	"An application is holding a reference to the IDWriteTextRenderer interface after the ...",
	"Shader construction failed because it was too complex",
	"An effect attempted to use a transform with too many inputs",
	"The requested operation is not supported",
	"The pixel format is not supported",
	"The requested Direct2D version is not supported",
	"An unknown Win32 failure occurred",
	"Objects used together were not all created from the same factory instance",
	"The resource used was created by a render target in a different resource domain",
	"The object was not in the correct state to process the method",
	"The supplied vector is zero"
};
const HRESULT hrErr[47]{
	D2DERR_BAD_NUMBER,
	D2DERR_BITMAP_BOUND_AS_TARGET,
	D2DERR_BITMAP_CANNOT_DRAW,
	D2DERR_CYCLIC_GRAPH,
	D2DERR_DISPLAY_FORMAT_NOT_SUPPORTED,
	D2DERR_DISPLAY_STATE_INVALID,
	D2DERR_EFFECT_IS_NOT_REGISTERED,
	D2DERR_EXCEEDS_MAX_BITMAP_SIZE,
	D2DERR_INCOMPATIBLE_BRUSH_TYPES,
	D2DERR_INSUFFICIENT_BUFFER,
	D2DERR_INSUFFICIENT_DEVICE_CAPABILITIES,
	D2DERR_INTERMEDIATE_TOO_LARGE,
	D2DERR_INTERNAL_ERROR,
	D2DERR_INVALID_CALL,
	D2DERR_INVALID_GRAPH_CONFIGURATION,
	D2DERR_INVALID_INTERNAL_GRAPH_CONFIGURATION,
	D2DERR_INVALID_PROPERTY,
	D2DERR_INVALID_TARGET,
	D2DERR_LAYER_ALREADY_IN_USE,
	D2DERR_MAX_TEXTURE_SIZE_EXCEEDED,
	D2DERR_NO_HARDWARE_DEVICE,
	D2DERR_NO_SUBPROPERTIES,
	D2DERR_NOT_INITIALIZED,
	D2DERR_ORIGINAL_TARGET_NOT_BOUND,
	D2DERR_OUTSTANDING_BITMAP_REFERENCES,
	D2DERR_POP_CALL_DID_NOT_MATCH_PUSH,
	D2DERR_PRINT_FORMAT_NOT_SUPPORTED,
	D2DERR_PRINT_JOB_CLOSED,
	D2DERR_PUSH_POP_UNBALANCED,
	D2DERR_RECREATE_TARGET,
	D2DERR_RENDER_TARGET_HAS_LAYER_OR_CLIPRECT,
	D2DERR_SCANNER_FAILED,
	D2DERR_SCREEN_ACCESS_DENIED,
	D2DERR_SHADER_COMPILE_FAILED,
	D2DERR_TARGET_NOT_GDI_COMPATIBLE,
	D2DERR_TEXT_EFFECT_IS_WRONG_TYPE,
	D2DERR_TEXT_RENDERER_NOT_RELEASED,
	D2DERR_TOO_MANY_SHADER_ELEMENTS,
	D2DERR_TOO_MANY_TRANSFORM_INPUTS,
	D2DERR_UNSUPPORTED_OPERATION,
	D2DERR_UNSUPPORTED_PIXEL_FORMAT,
	D2DERR_UNSUPPORTED_VERSION,
	D2DERR_WIN32_ERROR,
	D2DERR_WRONG_FACTORY,
	D2DERR_WRONG_RESOURCE_DOMAIN,
	D2DERR_WRONG_STATE,
	D2DERR_ZERO_VECTOR
};

void showErr(HWND hwnd, HRESULT error, string ev) {
	
	for (int e = 0; e < 47; e++) {
		if (error == hrErr[e]) {
			string errStr = "ERROR : " + errDesc[e];

			//.........Convert your strings here. I did this on the fly, so sorry aout the mess :D
			//MessageBox(hwnd, [err], [event], MB_OK | MB_ICONEXCLAMATION);

		}
	}
}

string event = "drawingg ...";
hr = deviceContext->EndDraw();
if (SUCCEEDED(hr)) {}
else { showErr(m_hwnd, hr, event); }

Share via

How can I get the error message that occurs in the Draw method?

2 additional answers

Your answer