Source code for win32ctypes.pywin32.win32api
#
# (C) Copyright 2014 Enthought, Inc., Austin, TX
# All right reserved.
#
# This file is open source software distributed according to the terms in
# LICENSE.txt
#
""" A module, encapsulating the Windows Win32 API. """
from __future__ import absolute_import
from win32ctypes.core import _common, _kernel32
from win32ctypes.pywin32.pywintypes import pywin32error as _pywin32error
LOAD_LIBRARY_AS_DATAFILE = 0x2
LANG_NEUTRAL = 0x00
[docs]def LoadLibraryEx(fileName, handle, flags):
""" Loads the specified DLL, and returns the handle.
Parameters
----------
fileName : unicode
The filename of the module to load.
handle :
Reserved, always zero.
flags :
The action to be taken when loading the module.
Returns
-------
hModule :
The handle of the loaded module
See also
--------
- `LoadLibraryEx MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms684179(v=vs.85).aspx>`_
"""
if not handle == 0:
raise ValueError("handle != 0 not supported")
with _pywin32error():
return _kernel32._LoadLibraryEx(fileName, 0, flags)
[docs]def EnumResourceTypes(hModule):
""" Enumerates resource types within a module.
Parameters
----------
hModule : handle
The handle to the module.
Returns
-------
resource_types : list
The list of resource types in the module.
See also
--------
- `EnumResourceTypes MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648039(v=vs.85).aspx>`_
"""
resource_types = []
def callback(hModule, type_, param):
resource_types.append(type_)
return True
with _pywin32error():
_kernel32._EnumResourceTypes(
hModule, _kernel32.ENUMRESTYPEPROC(callback), 0)
return resource_types
[docs]def EnumResourceNames(hModule, resType):
""" Enumerates all the resources of the specified type within a module.
Parameters
----------
hModule : handle
The handle to the module.
resType : str : int
The type of resource to enumerate. If ``resType`` is a string starting with
'#' is should be followed by the decimal number that define the integer
resource type identifier.
Returns
-------
resource_names : list
The list of resource names (unicode strings) of the specific
resource type in the module.
See also
--------
- `EnumResourceNames MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648037(v=vs.85).aspx>`_
- `Predefined resource types <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648009(v=vs.85).aspx>`_
"""
resource_names = []
def callback(hModule, type_, type_name, param):
resource_names.append(type_name)
return True
with _pywin32error():
_kernel32._EnumResourceNames(
hModule, resType, _kernel32.ENUMRESNAMEPROC(callback), 0)
return resource_names
[docs]def EnumResourceLanguages(hModule, lpType, lpName):
""" List languages of a resource module.
Parameters
----------
hModule : handle
Handle to the resource module.
lpType : str : int
The type of resource to enumerate. If ``lpType`` is a string starting with
'#' is should be followed by the decimal number that define the integer
resource type identifier.
lpName : str : int
The name of resource to enumerate. If ``lpType`` is a string starting with
'#' is should be followed by the decimal number that define the integer
resource type identifier.
Returns
-------
resource_languages : list
List of the resource language ids.
See also
--------
- `EnumResourceLanguages MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648035(v=vs.85).aspx>`_
- `Predefined resource types <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648009(v=vs.85).aspx>`_
- `Predefined resource language ids <https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693(v=vs.85).aspx>`_
"""
resource_languages = []
def callback(hModule, type_name, res_name, language_id, param):
resource_languages.append(language_id)
return True
with _pywin32error():
_kernel32._EnumResourceLanguages(
hModule, lpType, lpName, _kernel32.ENUMRESLANGPROC(callback), 0)
return resource_languages
[docs]def LoadResource(hModule, type, name, language=LANG_NEUTRAL):
""" Find and Load a resource component.
Parameters
----------
handle :
The handle of the module containing the resource.
Use None for currrent process executable.
type : str : int
The type of resource to load.
name :
The name or Id of the resource to load.
language : int
Language to use, default is LANG_NEUTRAL.
Returns
-------
hModule :
Handle of the loaded source.
See also
--------
- `FindResourceEx MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648043(v=vs.85).aspx>`_
- `SizeofResource MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648048(v=vs.85).aspx>`_
- `LoadResource MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648046(v=vs.85).aspx>`_
- `LockResource MSDN reference <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648047(v=vs.85).aspx>`_
- `Predefined resource types <https://msdn.microsoft.com/en-us/library/windows/desktop/ms648009(v=vs.85).aspx>`_
- `Predefined resource language ids <https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693(v=vs.85).aspx>`_
"""
with _pywin32error():
hrsrc = _kernel32._FindResourceEx(hModule, type, name, language)
size = _kernel32._SizeofResource(hModule, hrsrc)
hglob = _kernel32._LoadResource(hModule, hrsrc)
pointer = _kernel32._LockResource(hglob)
return _common._PyBytes_FromStringAndSize(pointer, size)
[docs]def FreeLibrary(hModule):
""" Free the loaded dynamic-link library (DLL) module.
If necessary, decrements its reference count.
Parameters
----------
hModule :
The handle to the library as returned by the LoadLibrary function.
"""
with _pywin32error():
return _kernel32._FreeLibrary(hModule)
