Skip to content
No description, website, or topics provided.
Ruby
Branch: master
Clone or download
Latest commit 8072d8b May 11, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Bump to 0.1.3 May 11, 2017
spec make to_s useful Mar 13, 2017
.gitignore
.pullreview.yml add pullreview yml file Jul 23, 2015
.rspec add rspec formatting Jun 12, 2015
.simplecov add travis and simplecov configs Jun 12, 2015
.travis.yml be more specific Jan 17, 2017
CONTRIBUTING.md Update CONTRIBUTING.md Jun 12, 2015
Gemfile remove metasploit-version dependencies, update for Ruby 2.4 Integer c… Jan 17, 2017
LICENSE.txt update license file Jun 12, 2015
README.md coveralls badge fixup Jun 29, 2015
Rakefile alias default rake task to spec Jun 29, 2015
windows_error.gemspec

README.md

WindowsError

Gem Version Build Status Code Climate Coverage Status PullReview stats

The WindowsError gem provides an easily accessible reference for standard Windows API Error Codes. It allows you to do comparisons as well as direct lookups of error codes to translate the numerical value returned by the API, into a meaningful and human readable message. WindowsError currently supports NTSTATUS and Win32 Error Codes. See Windows Error Codes for more details on all Windows Error Codes.

Installation

Add this line to your application's Gemfile:

gem 'windows_error'

And then execute:

$ bundle

Or install it yourself as:

$ gem install windows_error

Usage

###Looking up an NTSTATUS code Code:

require 'windows_error/nt_status'
return_value_from_api_call = 0x00000000
error_codes = WindowsError::NTStatus.find_by_retval(return_value_from_api_call)
error_codes.each do |error_code|
	puts "#{error_code.name}: #{error_code.description}"
end

Output:

STATUS_SUCCESS: The operation completed successfully.
STATUS_WAIT_0: The caller specified WaitAny for WaitType and one of the dispatcher objects in the Object array has been set to the signaled state.

###Looking up a Win32 code Code:

require 'windows_error/win32'
return_value_from_api_call = 0x00000002
error_codes = WindowsError::Win32.find_by_retval(return_value_from_api_call)
error_codes.each do |error_code|
	puts "#{error_code.name}: #{error_code.description}"
end

Output:

ERROR_FILE_NOT_FOUND: The system cannot find the file specified.

###Testing Equality

require 'windows_error/win32'
return_value_from_api_call = 0x00000002
return_value_from_api_call == WindowsError::Win32::ERROR_FILE_NOT_FOUND #=> true
WindowsError::Win32::ERROR_FILE_NOT_FOUND == return_value_from_api_call #=> true
0x00000001 == WindowsError::Win32::ERROR_FILE_NOT_FOUND #=> false

Contributing

  1. Fork it ( https://github.com/[my-github-username]/windows_error/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request
You can’t perform that action at this time.