Add additional information about error codes and [XSR:] #123
Conversation
TheNullicorn
left a comment
TheNullicorn
left a comment
There was a problem hiding this comment.
An example for [XSR:] is a nice addition.
I'm a bit iffy on the errors table, since there's a lot of different ways for each error to pop up, and a table doesn't do great job of conveying that
docs/operating-system/xcrdutil.md
Outdated
| | 0x80070490 | Unknown | `ERROR_NOT_FOUND` 0x490 | Unknown | ```xcrdutil -read_ud [XSR:]D:\DevelopmentFiles\gamecore.xvd 0 200 gamecore.vbi``` (as elevated admin account) | | ||
|
|
||
| **NOTE**: It is possible that error codes have changed over time with newer xcrdutil versions, and the table might not be completely accurate. | ||
| **NOTE 2**: Error codes are typically HRESULTs. HRESULTs in the form 0x8007XXXX typically come from the `HRESULT_FROM_WIN32` macro, with the last 4 digits corresponding to a Win32 error code. This makes sense for some errors, but not all of them. |
There was a problem hiding this comment.
This makes sense for some errors, but not all of them.
What do you mean by this?
There was a problem hiding this comment.
I should've phrased that better, I think what I meant to say is that the errors it gives don't always make a lot of sense with the information it gives in the first place, but that's to be expected.
docs/operating-system/xcrdutil.md
Outdated
| | 0x8007048F | Path not found | `ERROR_DEVICE_NOT_CONNECTED` 0x48F | This error appears when trying to create/access a file in a XCRD path that does not exist. | ```xcrdutil -c [XE0:]\someinvalidpath``` | | ||
| | 0x80070032 | Unknown | `ERROR_REQUEST_NOT_SUPPORTED` 0x32 | Possibly meaning the passed XVD does not have region information | ```xcrdutil -Specifiers [XUC:]\someXvdYouveMounted``` | | ||
| | 0x80070005 | Unknown | `ERROR_ACCESS_DENIED` 0x5 | Unknown | ```xcrdutil -read_blob \??\F:\host.xvd D:\DevelopmentFiles\host.xvd.dmp``` (as elevated admin account) | | ||
| | 0x80070490 | Unknown | `ERROR_NOT_FOUND` 0x490 | Unknown | ```xcrdutil -read_ud [XSR:]D:\DevelopmentFiles\gamecore.xvd 0 200 gamecore.vbi``` (as elevated admin account) | |
There was a problem hiding this comment.
Unknown
That command fails because read_ud requires the target to be actively mounted or streamed (though it doesn't say this anywhere). "Not found" here refers to not finding the XVD in the current streaming session nor the VM's mount list
There was a problem hiding this comment.
That's good to know, I'll add that.
|
The error table was already there and it kept bothering me that it just said "Unknown" when those are actually Win32 errors, so I added them because I think they make it at least a little bit more clear why it's not happy. Like ERROR_ACCESS_DENIED makes sense for manipulating host.xvd in SystemOS. But I think you're right about it not being a good way to convey what the errors mean. I'll make the changes now. |
Co-authored-by: nullicorn <git@nullicorn.me>
Co-authored-by: nullicorn <git@nullicorn.me>
|
Ok that should be most of the changes. Sorry it was messy, this is one of the first PRs I've submitted. |
TheNullicorn
left a comment
TheNullicorn
left a comment
There was a problem hiding this comment.
Just added two minor suggestions and then it's all good by me. The table is alright for now until there's time to make something more detailed
Co-authored-by: nullicorn <git@nullicorn.me>
Co-authored-by: nullicorn <git@nullicorn.me>
3 participants
These are just some observations I've made that could be useful.