Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support SAL Annotations In functions.h #94

Merged
merged 7 commits into from
Jun 11, 2016
Merged

Support SAL Annotations In functions.h #94

merged 7 commits into from
Jun 11, 2016

Conversation

opalmer
Copy link
Owner

@opalmer opalmer commented Jun 11, 2016

The functions.h file used to require that you specify functions like this:

BOOL WriteFile(HANDLE, LPCVOID, DWORD, LPDWORD, LPOVERLAPPED);

When the MSDN documentation says:

BOOL WINAPI WriteFile(
    _In_        HANDLE       hFile,
    _In_        LPCVOID      lpBuffer,
    _In_        DWORD        nNumberOfBytesToWrite,
    _Out_opt_   LPDWORD      lpNumberOfBytesWritten,
    _Inout_opt_ LPOVERLAPPED lpOverlapped
);

These are known as SAL Annotations. These annotations are normally used on the Windows side to help with development and reduce defects. For pywincffi, there are two primary purposes:

  • Support direct copy/paste from the MSDN documentation
  • Make it easier to see at a glance what the expected inputs and outputs are.

@opalmer opalmer self-assigned this Jun 11, 2016
@opalmer opalmer added this to the 0.3.0 milestone Jun 11, 2016
@codecov-io
Copy link

Current coverage is 98.52%

Merging #94 into master will increase coverage by <.01%

Powered by Codecov. Last updated by 3acaad5...a6d0e7c

@opalmer opalmer merged commit 98fcc78 into master Jun 11, 2016
@opalmer opalmer deleted the sal_annotations branch June 18, 2016 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants