Derived from TModule, TApplication supplies functionality common to all ObjectWindows applications. More...

Classes
class	owl::TAppDictionary
	TAppDictionary implementation for DLLs only. More...

class	owl::TApplication
	Derived from TModule and TMsgThread and virtually derived from TEventHandler, TApplication acts as an object-oriented stand-in for an application module. More...

class	owl::TLangModule
	International resource support: [APP]ENG.DLL - default application module. More...

class	owl::TWindowClassName
	Type-safe encapsulation of a Windows class name, a union between ATOM and LPCTSTR. More...

class	owl::TModule
	ObjectWindows dynamic-link libraries (DLLs) construct an instance of TModule, which acts as an object-oriented stand-in for the library (DLL) module. More...

class	owl::TModuleVersionInfo
	TModuleVersionInfo provides access to a TModule's VERSIONINFO resource. More...

class	owl::TXInvalidModule
	A nested class, TXInvalidModule describes an exception that results from an invalid module. More...

class	owl::TXModuleVersionInfo
	Exception class for TModuleVersionInfo. [VH 2005-04-03]. More...

class	owl::TSystemMessage

class	owl::TErrorMode
	Simple encapsulation of the SetErrorMode call. More...

class	owl::TDllLoader< T >
	TDllLoader<> provides an easy way to load one instance of a DLL on demand. More...

class	owl::TModuleProc
	TModuleProc is a base class that does inital binding of a function name or ordinal to the corresponding function in the given module (DLL). More...

class	owl::TUser
	delay loading USER :), just for some memory/resource check programs More...

class	owl::TVersion
	delay loading VERSION.DLL More...

class	owl::TOle
	delay loading Ole32.DLL/COMPOBJ.DLL More...

class	owl::TOleAuto
	delay loading OLEAUT32.DLL/OLE2DISP.DLL More...

Typedefs
typedef HINSTANCE	owl::TModule::THandle
	TModule encapsulates an HINSTANCE.

Enumerations
enum	owl::TModuleVersionInfo::TFileOS { owl::TModuleVersionInfo::OSUnknown = VOS_UNKNOWN , owl::TModuleVersionInfo::DOS = VOS_DOS , owl::TModuleVersionInfo::OS216 = VOS_OS216 , owl::TModuleVersionInfo::OS232 = VOS_OS232 , owl::TModuleVersionInfo::NT = VOS_NT , owl::TModuleVersionInfo::Windows16 = VOS__WINDOWS16 , owl::TModuleVersionInfo::PM16 = VOS__PM16 , owl::TModuleVersionInfo::PM32 = VOS__PM32 , owl::TModuleVersionInfo::Windows32 = VOS__WINDOWS32 , owl::TModuleVersionInfo::DosWindows16 = VOS_DOS_WINDOWS16 , owl::TModuleVersionInfo::DosWindows32 = VOS_DOS_WINDOWS32 , owl::TModuleVersionInfo::OS216PM16 = VOS_OS216_PM16 , owl::TModuleVersionInfo::OS232PM32 = VOS_OS232_PM32 , owl::TModuleVersionInfo::NTWindows32 = VOS_NT_WINDOWS32 }
	TFileOS values are returned by GetFileOS() More...

enum	owl::TModuleVersionInfo::TFileType { owl::TModuleVersionInfo::TypeUnknown = VFT_UNKNOWN , owl::TModuleVersionInfo::App = VFT_APP , owl::TModuleVersionInfo::DLL = VFT_DLL , owl::TModuleVersionInfo::DevDriver = VFT_DRV , owl::TModuleVersionInfo::Font = VFT_FONT , owl::TModuleVersionInfo::VirtDevice = VFT_VXD , owl::TModuleVersionInfo::StaticLib = VFT_STATIC_LIB }
	TFileType is returned by GetFileType() More...

enum	owl::TModuleVersionInfo::TFileSubType { owl::TModuleVersionInfo::UnknownDevDriver , owl::TModuleVersionInfo::PtrDriver , owl::TModuleVersionInfo::KybdDriver , owl::TModuleVersionInfo::LangDriver , owl::TModuleVersionInfo::DisplayDriver , owl::TModuleVersionInfo::MouseDriver , owl::TModuleVersionInfo::NtwkDriver , owl::TModuleVersionInfo::SysDriver , owl::TModuleVersionInfo::InstallableDriver , owl::TModuleVersionInfo::SoundDriver , owl::TModuleVersionInfo::UnknownFont , owl::TModuleVersionInfo::RasterFont , owl::TModuleVersionInfo::VectorFont , owl::TModuleVersionInfo::TrueTypeFont }
	TFileSubType values are returned by GetFileSubType() if GetFileType. More...

Functions
	owl::TWindowClassName::TWindowClassName (ATOM a)

	owl::TWindowClassName::TWindowClassName (LPCTSTR s)

auto	owl::TWindowClassName::GetPointerRepresentation () const -> LPCTSTR

auto	owl::TWindowClassName::IsString () const -> bool

auto	owl::TWindowClassName::IsAtom () const -> bool

auto	owl::TWindowClassName::GetString () const -> tstring
	Returns the class name in string form.

auto	owl::TWindowClassName::GetAtom () const -> ATOM

	owl::TModule::TModule (const tstring &name, bool shouldLoad=true, bool mustLoad=true, bool addToList=true)
	Constructs a TModule object that is used as an alias for a DLL.

	owl::TModule::TModule (LPCTSTR name, THandle handle, bool addToList=true)
	Constructs a TModule object that is an alias for an already loaded DLL or program with an available HInstance.

	owl::TModule::TModule (const tstring &name, THandle handle, bool addToList=true)
	String-aware overload.

	owl::TModule::TModule (LPCTSTR name, THandle handle, const tstring &cmdLine, bool addToList=true)
	Constructs a TModule object for an ObjectWindows DLL or program from within LibMain or WinMain.

	owl::TModule::TModule (const tstring &name, THandle handle, const tstring &cmdLine, bool addToList=true)
	String-aware overload.

virtual	owl::TModule::~TModule ()
	Destructs a TModule, freeing the instance if appropriate, and deleting new'd strings.

void	owl::TModule::InitModule (THandle handle, const tstring &cmdLine)
	Finish-up initialization of a module.

virtual int	owl::TModule::Error (TXBase &x, uint captionResId, uint promptResId=0)
	Replaceable exception handler; may be redefined to process OWL exceptions if canResume is false, then the user doesn't have the option of ignoring.

void	owl::TModule::SetHandle (THandle handle)
	Set the module instance handle.

	owl::TModuleVersionInfo::TModuleVersionInfo (TModule::THandle module)
	Constructs a TModuleVersionInfo given a module or instance handle.

	owl::TModuleVersionInfo::TModuleVersionInfo (const tstring &modFName)
	Constructs a TModuleVersionInfo given a module filename String version.

	owl::TModuleVersionInfo::~TModuleVersionInfo ()

VS_FIXEDFILEINFO &	owl::TModuleVersionInfo::GetFixedInfo ()
	Return the version information about this module.

uint32	owl::TModuleVersionInfo::GetSignature () const

uint32	owl::TModuleVersionInfo::GetStrucVersion () const

uint32	owl::TModuleVersionInfo::GetFileVersionMS () const
	Get the major file version (first 32-bits).

uint32	owl::TModuleVersionInfo::GetFileVersionLS () const
	Get the minor file version (last 32-bits).

uint32	owl::TModuleVersionInfo::GetProductVersionMS () const
	Get the major product version number (first 32-bits).

uint32	owl::TModuleVersionInfo::GetProductVersionLS () const
	Get the minor product version number (last 32-bits).

bool	owl::TModuleVersionInfo::IsFileFlagSet (uint32 flag) const
	Return true if the flag has been set in the version info.

uint32	owl::TModuleVersionInfo::GetFileFlagsMask () const

uint32	owl::TModuleVersionInfo::GetFileFlags () const

bool	owl::TModuleVersionInfo::IsDebug () const

bool	owl::TModuleVersionInfo::InfoInferred () const

bool	owl::TModuleVersionInfo::IsPatched () const

bool	owl::TModuleVersionInfo::IsPreRelease () const

bool	owl::TModuleVersionInfo::IsPrivateBuild () const

bool	owl::TModuleVersionInfo::IsSpecialBuild () const

uint32	owl::TModuleVersionInfo::GetFileOS () const
	returns TFileOS values

TFileType	owl::TModuleVersionInfo::GetFileType () const

uint32	owl::TModuleVersionInfo::GetFileSubType () const
	Returns values of TFileType if GetFileType() returned DevDriver or Font.

FILETIME	owl::TModuleVersionInfo::GetFileDate () const
	Retrieves the file date.

bool	owl::TModuleVersionInfo::GetInfoString (LPCTSTR str, LPCTSTR &value, uint lang=0)
	Queries any given "\\StringFileInfo\\lang-charset\\<str>" version.

bool	owl::TModuleVersionInfo::GetFileDescription (LPCTSTR &fileDesc, uint lang=0)
	Retrieves the file description information in the requested language id.

bool	owl::TModuleVersionInfo::GetFileVersion (LPCTSTR &fileVersion, uint lang=0)
	Retrieves the file version information in the requested language id.

bool	owl::TModuleVersionInfo::GetInternalName (LPCTSTR &internalName, uint lang=0)
	Retrieves the internal name of the module.

bool	owl::TModuleVersionInfo::GetLegalCopyright (LPCTSTR &copyright, uint lang=0)
	Retrieves the copyright message.

bool	owl::TModuleVersionInfo::GetOriginalFilename (LPCTSTR &originalFilename, uint lang=0)
	Retrieves the original filename.

bool	owl::TModuleVersionInfo::GetProductName (LPCTSTR &prodName, uint lang=0)
	Retrieves the product name this module is associated with.

bool	owl::TModuleVersionInfo::GetProductVersion (LPCTSTR &prodVersion, uint lang=0)
	Retrieves the version of the product.

bool	owl::TModuleVersionInfo::GetSpecialBuild (LPCTSTR &debug, uint lang=0)
	Retrieves the special build number.

tstring	owl::TModuleVersionInfo::GetInfoString (const tstring &str, uint lang=0)

tstring	owl::TModuleVersionInfo::GetFileDescription (uint lang=0)
	Retrieves the file description information in the requested language id.

tstring	owl::TModuleVersionInfo::GetFileVersion (uint lang=0)
	Retrieves the file version information in the requested language id.

tstring	owl::TModuleVersionInfo::GetInternalName (uint lang=0)
	Retrieves the internal name of the module.

tstring	owl::TModuleVersionInfo::GetLegalCopyright (uint lang=0)
	Retrieves the copyright message.

tstring	owl::TModuleVersionInfo::GetOriginalFilename (uint lang=0)
	Retrieves the original filename.

tstring	owl::TModuleVersionInfo::GetProductName (uint lang=0)
	Retrieves the product name this module is associated with.

tstring	owl::TModuleVersionInfo::GetProductVersion (uint lang=0)
	Retrieves the version of the product.

tstring	owl::TModuleVersionInfo::GetSpecialBuild (uint lang=0)
	Retrieves the special build number.

uint	owl::TModuleVersionInfo::GetLanguage () const
	Return the language id of this module.

tstring	owl::TModuleVersionInfo::GetLanguageName () const
	Return the language name of this module.

static tstring	owl::TModuleVersionInfo::GetLanguageName (uint language)
	Gets the language name string associated with a language/charset code.

void	owl::TModuleVersionInfo::Init (LPCTSTR modFName)

	owl::TXInvalidModule::TXInvalidModule (const tstring &name=tstring())
	Creates the Invalid Module exception.

TXInvalidModule *	owl::TXInvalidModule::Clone ()
	Creates a copy of the exception.

void	owl::TXInvalidModule::Throw ()
	Throws the exception.

static void	owl::TXInvalidModule::Raise (const tstring &name=tstring())
	Throws the exception.

	owl::TXModuleVersionInfo::TXModuleVersionInfo (const tstring &name=tstring())
	Create the exception.

TXModuleVersionInfo *	owl::TXModuleVersionInfo::Clone ()
	Creates a copy of the exception.

void	owl::TXModuleVersionInfo::Throw ()
	Throws the exception.

static void	owl::TXModuleVersionInfo::Raise (const tstring &name=tstring())
	Throws the exception.

	owl::TSystemMessage::TSystemMessage ()
	default errorId, def language

	owl::TSystemMessage::TSystemMessage (uint32 error, TLangId langId=LangNeutral)

int	owl::TSystemMessage::MessageBox (TWindow *wnd, const tstring &msg, const tstring &title, uint flags=MB_OK) const

const tstring &	owl::TSystemMessage::SysMessage () const

uint32	owl::TSystemMessage::SysError () const

void	owl::TSystemMessage::Init (TLangId langId)

	owl::TErrorMode::TErrorMode (uint mode)
	Constructs a TErrorMode object which invokes the 'SetErrorMode' API function to control how/whether Windows handles interrupt 24h errors.

	owl::TErrorMode::~TErrorMode ()
	Destructor of TErrorMode object - restores the state of the error mode saved during construction of the object.

	owl::TDllLoader< T >::TDllLoader ()
	Creates a dynamic copy of the DLL object (i.e.

	owl::TDllLoader< T >::~TDllLoader ()
	Deletes the dll object when we go away to release the dll from memory.

static bool	owl::TDllLoader< T >::IsAvailable ()
	Load the dll on demand, returning true if it was loaded OK.

static T *	owl::TDllLoader< T >::Dll ()

Variables
uint8 *	owl::TModuleVersionInfo::Buff
	new'd File version info buffer

uint32	owl::TModuleVersionInfo::Lang
	Default language translation.

VS_FIXEDFILEINFO *	owl::TModuleVersionInfo::FixedInfo
	Fixed file info structure.

uint32	owl::TSystemMessage::Error

tstring	owl::TSystemMessage::Message

Friends
std::ostream &	owl::TModule::operator<< (std::ostream &os, const TModule &m)

Get & set members. Use these instead of directly accessing members
LPCTSTR	owl::TModule::GetName () const
	Returns the name of the module.

void	owl::TModule::SetName (LPCTSTR name)
	Accessor function that sets the name of the module.

void	owl::TModule::SetName (const tstring &name)
	String-aware overload.

THandle	owl::TModule::GetHandle () const
	Return the instance handle of the library module represented by the TModule obect.

	owl::TModule::operator THandle () const
	Returns the handle of the application or DLL module represented by this TModule.

bool	owl::TModule::operator== (const TModule &m) const
	Returns true if this instance is equal to the other instance; otherwise, returns false.

bool	owl::TModule::IsLoaded () const
	Returns a nonzero value if the instance handle is loaded.

Windows HINSTANCE/HMODULE related API functions encapsulated
int	owl::TModule::GetModuleFileName (TCHAR *buff, int maxChars) const
	Returns the expanded file name (path and file name) of the file from which this module was loaded.

tstring	owl::TModule::GetModuleFileName () const
	String-aware overload.

FARPROC	owl::TModule::GetProcAddress (TNarrowResId) const
	Returns the entry-point address of the specified exported function if found, otherwise returns NULL.

HRSRC	owl::TModule::FindResource (TResId id, TResId type) const
	Wrapper for the Windows API to find a particular resource.

HRSRC	owl::TModule::FindResourceEx (TResId id, TResId type, TLangId langId=LangNeutral) const
	Wrapper for the Windows API to find a particular resource.

HGLOBAL	owl::TModule::LoadResource (HRSRC hRsrc) const
	Wrapper for the Windows API.

uint32	owl::TModule::SizeofResource (HRSRC hRsrc) const
	Wrapper for the Windows API.

int	owl::TModule::LoadString (uint id, TCHAR *buf, int maxChars) const
	Loads a string resource identified by id into the buffer pointed to by buff.

tstring	owl::TModule::LoadString (uint id) const
	Loads a string resource identified by id.

HBITMAP	owl::TModule::LoadBitmap (TResId id) const
	Wrapper for the Windows API.

HACCEL	owl::TModule::LoadAccelerators (TResId id) const
	Wrapper for the Windows API.

HMENU	owl::TModule::LoadMenu (TResId id) const
	Wrapper for the Windows API.

HCURSOR	owl::TModule::LoadCursor (TResId id) const
	Wrapper for the Windows API.

HICON	owl::TModule::LoadIcon (TResId name) const
	Wrapper for the Windows API.

std::string	owl::TModule::LoadHtml (TResId) const
	Loads the given HTML resource and returns it as a narrow string.

HICON	owl::TModule::CopyIcon (HICON hIcon) const
	Wrapper for the Windows API.

auto	owl::TModule::GetClassInfo (TWindowClassName, WNDCLASS *wndclass) const -> bool
	Retrieves information about the given window class.

auto	owl::TModule::GetClassInfo (TWindowClassName) const -> WNDCLASS
	Functional-style overload.

auto	owl::TModule::IsRegisteredClass (TWindowClassName) const -> bool
	Returns `true` if the given window class has been registered.

Global search for resources
static TModule *	owl::TModule::FindResModule (TResId id, TResId type)
	Global search for resources.

static TModule *	owl::TModule::NextModule (TModule *module=nullptr)

Detailed Description

Derived from TModule, TApplication supplies functionality common to all ObjectWindows applications.

Classes derived from TApplication have the ability to create instances of a class, create main windows, and process messages. TModule defines behavior shared by both library (DLL) and application modules. Virtually derived from TModule.

Command enabling
Doc/view Print and print/preview

Typedef Documentation

◆ THandle

typedef HINSTANCE owl::TModule::THandle

TModule encapsulates an HINSTANCE.

Definition at line 79 of file module.h.

Enumeration Type Documentation

◆ TFileOS

enum owl::TModuleVersionInfo::TFileOS

TFileOS values are returned by GetFileOS()

Enumerator
OSUnknown
DOS
OS216
OS232
NT
Windows16
PM16
PM32
Windows32
DosWindows16
DosWindows32
OS216PM16
OS232PM32
NTWindows32

Definition at line 185 of file module.h.

◆ TFileSubType

enum owl::TModuleVersionInfo::TFileSubType

TFileSubType values are returned by GetFileSubType() if GetFileType.

Enumerator
UnknownDevDriver	VFT2_UNKNOWN.
PtrDriver	VFT2_DRV_PRINTER.
KybdDriver	VFT2_DRV_KEYBOARD.
LangDriver	VFT2_DRV_LANGUAGE.
DisplayDriver	VFT2_DRV_DISPLAY.
MouseDriver	VFT2_DRV_MOUSE.
NtwkDriver	VFT2_DRV_NETWORK.
SysDriver	VFT2_DRV_SYSTEM.
InstallableDriver	VFT2_DRV_INSTALLABLE.
SoundDriver	VFT2_DRV_SOUND.
UnknownFont	VFT2_UNKNOWN.
RasterFont	VFT2_FONT_RASTER.
VectorFont	VFT2_FONT_VECTOR.
TrueTypeFont	VFT2_FONT_TRUETYPE.

Definition at line 211 of file module.h.

◆ TFileType

enum owl::TModuleVersionInfo::TFileType

TFileType is returned by GetFileType()

Enumerator
TypeUnknown
App
DLL
DevDriver
Font
VirtDevice
StaticLib

Definition at line 201 of file module.h.

Function Documentation

◆ TDllLoader()

template<class T >

owl::TDllLoader< T >::TDllLoader ( )

Creates a dynamic copy of the DLL object (i.e.

an instance of T) if we do not have one already...

Definition at line 467 of file module.h.

◆ TErrorMode()

owl::TErrorMode::TErrorMode ( uint mode )

inline

Constructs a TErrorMode object which invokes the 'SetErrorMode' API function to control how/whether Windows handles interrupt 24h errors.

Definition at line 1571 of file module.h.

◆ TModule() [1/5]

owl::TModule::TModule	(	const tstring &	name,
		bool	shouldLoad = true,
		bool	mustLoad = true,
		bool	addToList = true )

explicit

Constructs a TModule object that is used as an alias for a DLL.

If shouldLoad is true, TModule will automatically load and free the DLL. If shouldLoad is false, then the HInstance needs to be set later using InitModule.

"mustLoad" determines if a load failure should cause an exception throw

Definition at line 308 of file module.cpp.

References _T, owl::TXInvalidModule::Raise(), owl::TModule::SetName(), and TRACEX.

◆ TModule() [2/5]

owl::TModule::TModule	(	const tstring &	name,
		THandle	handle,
		bool	addToList = true )

explicit

String-aware overload.

If an empty name is passed, and the module handle is valid, the name is retrieved using GetModuleFileName.

Definition at line 357 of file module.cpp.

References PRECONDITION, and owl::TModule::SetName().

◆ TModule() [3/5]

owl::TModule::TModule	(	const tstring &	name,
		THandle	handle,
		const tstring &	cmdLine,
		bool	addToList = true )

explicit

String-aware overload.

If an empty name is passed, and the module handle is valid, the name is retrieved using GetModuleFileName.

Definition at line 395 of file module.cpp.

References owl::TModule::InitModule(), and owl::TModule::SetName().

◆ TModule() [4/5]

owl::TModule::TModule	(	LPCTSTR	name,
		THandle	handle,
		bool	addToList = true )

explicit

Constructs a TModule object that is an alias for an already loaded DLL or program with an available HInstance.

When the TModule is destructed, the instance isn't automatically freed. name, which is optional, can be 0. No cmdLine is set up. If null-pointer is passed for name, and the module handle is valid, the name is retrieved using GetModuleFileName.

Definition at line 339 of file module.cpp.

References PRECONDITION, and owl::TModule::SetName().

◆ TModule() [5/5]

owl::TModule::TModule	(	LPCTSTR	name,
		THandle	handle,
		const tstring &	cmdLine,
		bool	addToList = true )

explicit

Constructs a TModule object for an ObjectWindows DLL or program from within LibMain or WinMain.

Calls InitModule to initialize hInstance and cmdLine. If null-pointer is passed for name, and the module handle is valid, the name is retrieved using GetModuleFileName.

Definition at line 376 of file module.cpp.

References owl::TModule::InitModule(), and owl::TModule::SetName().

◆ TModuleVersionInfo() [1/2]

owl::TModuleVersionInfo::TModuleVersionInfo ( const tstring & modFName )

Constructs a TModuleVersionInfo given a module filename String version.

Throws TXModuleVersionInfo on errors. [VH 2005-04-03]

Definition at line 52 of file modversi.cpp.

References owl::TModuleVersionInfo::Init().

◆ TModuleVersionInfo() [2/2]

owl::TModuleVersionInfo::TModuleVersionInfo ( TModule::THandle module )

Constructs a TModuleVersionInfo given a module or instance handle.

Definition at line 33 of file modversi.cpp.

References _MAX_PATH, owl::TModuleVersionInfo::Init(), and OemToAnsi.

◆ TSystemMessage() [1/2]

owl::TSystemMessage::TSystemMessage ( )

default errorId, def language

Definition at line 91 of file module.cpp.

References owl::TSystemMessage::Error, owl::TSystemMessage::Init(), and owl::LangNeutral.

◆ TSystemMessage() [2/2]

owl::TSystemMessage::TSystemMessage	(	uint32	error,
		TLangId	langId = LangNeutral )

Definition at line 100 of file module.cpp.

References owl::TSystemMessage::Error, and owl::TSystemMessage::Init().

◆ TWindowClassName() [1/2]

owl::TWindowClassName::TWindowClassName ( ATOM a )

inlineexplicit

Definition at line 50 of file module.h.

◆ TWindowClassName() [2/2]

owl::TWindowClassName::TWindowClassName ( LPCTSTR s )

inlineexplicit

Definition at line 51 of file module.h.

◆ TXInvalidModule()

owl::TXInvalidModule::TXInvalidModule ( const tstring & name = tstring() )

Creates the Invalid Module exception.

Definition at line 1271 of file module.cpp.

◆ TXModuleVersionInfo()

owl::TXModuleVersionInfo::TXModuleVersionInfo ( const tstring & name = tstring() )

Create the exception.

Definition at line 393 of file modversi.cpp.

◆ ~TDllLoader()

template<class T >

owl::TDllLoader< T >::~TDllLoader ( )

Deletes the dll object when we go away to release the dll from memory.

Definition at line 483 of file module.h.

◆ ~TErrorMode()

owl::TErrorMode::~TErrorMode ( )

inline

Destructor of TErrorMode object - restores the state of the error mode saved during construction of the object.

Definition at line 1580 of file module.h.

◆ ~TModule()

owl::TModule::~TModule ( )

virtual

Destructs a TModule, freeing the instance if appropriate, and deleting new'd strings.

Definition at line 414 of file module.cpp.

◆ ~TModuleVersionInfo()

owl::TModuleVersionInfo::~TModuleVersionInfo ( )

Definition at line 119 of file modversi.cpp.

References owl::TModuleVersionInfo::Buff.

◆ Clone() [1/2]

TXInvalidModule * owl::TXInvalidModule::Clone ( )

virtual

Creates a copy of the exception.

Reimplemented from owl::TXBase.

Definition at line 1281 of file module.cpp.

References owl::TXInvalidModule::TXInvalidModule().

◆ Clone() [2/2]

TXModuleVersionInfo * owl::TXModuleVersionInfo::Clone ( )

virtual

Creates a copy of the exception.

Reimplemented from owl::TXBase.

Definition at line 403 of file modversi.cpp.

References owl::TXModuleVersionInfo::TXModuleVersionInfo().

◆ CopyIcon()

HICON owl::TModule::CopyIcon ( HICON hIcon ) const

inline

Wrapper for the Windows API.

Copies the icon specified in hIcon. The return value is a handle to the icon or 0 if unsuccessful. When no longer required, the duplicate icon should be destroyed.

Definition at line 1383 of file module.h.

◆ Dll()

template<class T >

T * owl::TDllLoader< T >::Dll ( )

static

Definition at line 508 of file module.h.

References PRECONDITION.

◆ Error()

int owl::TModule::Error	(	TXBase &	x,
		uint	captionResId,
		uint	promptResId = 0 )

virtual

Replaceable exception handler; may be redefined to process OWL exceptions if canResume is false, then the user doesn't have the option of ignoring.

Called when fatal exceptions occur, Error takes an xmsg exception object, a resource ID for a message box caption, and an optional resource ID for a user prompt. By default, Error calls HandleGlobalException with the xmsg object and the strings obtained from the resources. An application (derived from TApplication which is derived from TModule) can reimplement this function to provide alternative behavior. A nonzero status code is returned to indicate that an error condition is to be propagated; a zero status indicates that the condition has been handled and that it is OK to proceed. ObjectWindows uses this status code inside its message loop to allow the program to resume. The global error handler (defined in except.h), which displays the message text, is

int _OWLFUNC HandleGlobalException(xmsg& x, char* caption, char* canResume);

VarType

Definition safearray.h:14

owl::HandleGlobalException

int HandleGlobalException(owl::TXBase &x, LPCTSTR caption, LPCTSTR canResume=nullptr)

Definition except.cpp:29

_OWLFUNC

#define _OWLFUNC(p)

Definition defs.h:341

Definition at line 522 of file module.cpp.

References _T, owl::HandleGlobalException(), and owl::TModule::LoadString().

◆ FindResModule()

TModule * owl::TModule::FindResModule	(	TResId	id,
		TResId	type )

static

Global search for resources.

Definition at line 429 of file module.cpp.

◆ FindResource()

HRSRC owl::TModule::FindResource	(	TResId	id,
		TResId	type ) const

inline

Wrapper for the Windows API to find a particular resource.

Finds the resource indicated by id and type and, if successful, returns a handle to the specified resource. If the resource cannot be found, the return value is zero. The id and type parameters either point to zero-terminated strings or specify an integer value. type can be one of the standard resource types defined below.

RT_ACCELERATOR Accelerator table
RT_BITMAP Bitmap
RT_CURSOR Cursor
RT_DIALOG Dialog box
RT_FONT Font
RT_FONTDIR Font directory
RT_ICON Icon
RT_MENU Menu
RT_RCDATA User-defined resource
RT_STRING String

Definition at line 1308 of file module.h.

References PRECONDITION.

◆ FindResourceEx()

HRSRC owl::TModule::FindResourceEx	(	TResId	id,
		TResId	type,
		TLangId	langId = LangNeutral ) const

inline

Wrapper for the Windows API to find a particular resource.

WIN32: Finds the resource indicated by id and type and, if successful, returns a handle to the specified resource. If the resource cannot be found, the return value is zero. The id and type parameters either point to zero-terminated strings or specify an integer value. type can be one of the standard resource types defined below.

RT_ACCELERATOR Accelerator table
RT_BITMAP Bitmap
RT_CURSOR Cursor
RT_DIALOG Dialog box
RT_FONT Font
RT_FONTDIR Font directory
RT_ICON Icon
RT_MENU Menu
RT_RCDATA User-defined resource
RT_STRING String

Definition at line 1334 of file module.h.

References PRECONDITION.

◆ GetAtom()

auto owl::TWindowClassName::GetAtom ( ) const -> ATOM

inline

Definition at line 57 of file module.h.

References PRECONDITION.

◆ GetClassInfo() [1/2]

auto owl::TModule::GetClassInfo ( TWindowClassName name ) const -> WNDCLASS

Functional-style overload.

Throws TXOwl on error.

Definition at line 996 of file module.cpp.

References _T.

◆ GetClassInfo() [2/2]

auto owl::TModule::GetClassInfo	(	TWindowClassName	name,
		WNDCLASS *	wndclass ) const -> bool

inline

Retrieves information about the given window class.

This is a wrapper for the Windows API function GetClassInfo. http://msdn.microsoft.com/en-us/library/windows/desktop/ms633578.aspx

See also: TClassName

Definition at line 1394 of file module.h.

References owl::TUser::GetClassInfo(), and PRECONDITION.

◆ GetFileDate()

FILETIME owl::TModuleVersionInfo::GetFileDate ( ) const

Retrieves the file date.

Definition at line 377 of file modversi.cpp.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFileDescription() [1/2]

bool owl::TModuleVersionInfo::GetFileDescription	(	LPCTSTR &	fileDesc,
		uint	lang = 0 )

Retrieves the file description information in the requested language id.

Definition at line 146 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetFileDescription() [2/2]

tstring owl::TModuleVersionInfo::GetFileDescription ( uint lang = 0 )

Retrieves the file description information in the requested language id.

String version. [VH 2005-04-03]

Definition at line 240 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetFileDescription().

◆ GetFileFlags()

uint32 owl::TModuleVersionInfo::GetFileFlags ( ) const

inline

Definition at line 1477 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFileFlagsMask()

uint32 owl::TModuleVersionInfo::GetFileFlagsMask ( ) const

inline

Definition at line 1470 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFileOS()

uint32 owl::TModuleVersionInfo::GetFileOS ( ) const

inline

returns TFileOS values

Definition at line 1532 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFileSubType()

uint32 owl::TModuleVersionInfo::GetFileSubType ( ) const

Returns values of TFileType if GetFileType() returned DevDriver or Font.

If GetFileType() returned VirtDriver, this function returns the virtual device identifier included in the virtual device control block.

Definition at line 309 of file modversi.cpp.

◆ GetFileType()

TModuleVersionInfo::TFileType owl::TModuleVersionInfo::GetFileType ( ) const

inline

Definition at line 1539 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFileVersion() [1/2]

bool owl::TModuleVersionInfo::GetFileVersion	(	LPCTSTR &	fileVersion,
		uint	lang = 0 )

Retrieves the file version information in the requested language id.

Definition at line 155 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetFileVersion() [2/2]

tstring owl::TModuleVersionInfo::GetFileVersion ( uint lang = 0 )

Retrieves the file version information in the requested language id.

String version. [VH 2005-04-03]

Definition at line 247 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetFileVersion().

◆ GetFileVersionLS()

uint32 owl::TModuleVersionInfo::GetFileVersionLS ( ) const

inline

Get the minor file version (last 32-bits).

Definition at line 1436 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFileVersionMS()

uint32 owl::TModuleVersionInfo::GetFileVersionMS ( ) const

inline

Get the major file version (first 32-bits).

Definition at line 1427 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetFixedInfo()

VS_FIXEDFILEINFO & owl::TModuleVersionInfo::GetFixedInfo ( )

inline

Return the version information about this module.

Definition at line 1404 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetHandle()

TModule::THandle owl::TModule::GetHandle ( ) const

inline

Return the instance handle of the library module represented by the TModule obect.

Definition at line 1233 of file module.h.

◆ GetInfoString() [1/2]

tstring owl::TModuleVersionInfo::GetInfoString	(	const tstring &	str,
		uint	lang = 0 )

Definition at line 230 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetInfoString().

◆ GetInfoString() [2/2]

bool owl::TModuleVersionInfo::GetInfoString	(	LPCTSTR	str,
		LPCTSTR &	value,
		uint	lang = 0 )

Queries any given "\\StringFileInfo\\lang-charset\\<str>" version.

Info string lang indicates the language translation, may be 0 to signify file default.

Definition at line 129 of file modversi.cpp.

References _stprintf, owl::TModuleVersionInfo::Buff, owl::TModuleVersionInfo::Lang, MAX_PATH, PRECONDITION, and owl::TVersion::VerQueryValue().

◆ GetInternalName() [1/2]

bool owl::TModuleVersionInfo::GetInternalName	(	LPCTSTR &	internalName,
		uint	lang = 0 )

Retrieves the internal name of the module.

Definition at line 164 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetInternalName() [2/2]

tstring owl::TModuleVersionInfo::GetInternalName ( uint lang = 0 )

Retrieves the internal name of the module.

String version. [VH 2005-04-03]

Definition at line 254 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetInternalName().

◆ GetLanguage()

uint owl::TModuleVersionInfo::GetLanguage ( ) const

inline

Return the language id of this module.

Definition at line 1548 of file module.h.

References owl::TModuleVersionInfo::Lang.

◆ GetLanguageName() [1/2]

tstring owl::TModuleVersionInfo::GetLanguageName ( ) const

inline

Return the language name of this module.

Definition at line 1556 of file module.h.

References owl::TModuleVersionInfo::GetLanguage(), and owl::TModuleVersionInfo::GetLanguageName().

◆ GetLanguageName() [2/2]

tstring owl::TModuleVersionInfo::GetLanguageName ( uint language )

static

Gets the language name string associated with a language/charset code.

Definition at line 296 of file modversi.cpp.

References owl::TVersion::VerLanguageName().

◆ GetLegalCopyright() [1/2]

bool owl::TModuleVersionInfo::GetLegalCopyright	(	LPCTSTR &	copyright,
		uint	lang = 0 )

Retrieves the copyright message.

Definition at line 173 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetLegalCopyright() [2/2]

tstring owl::TModuleVersionInfo::GetLegalCopyright ( uint lang = 0 )

Retrieves the copyright message.

String version. [VH 2005-04-03]

Definition at line 261 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetLegalCopyright().

◆ GetModuleFileName() [1/2]

tstring owl::TModule::GetModuleFileName ( ) const

String-aware overload.

Definition at line 555 of file module.cpp.

References _MAX_PATH, and owl::CopyText().

◆ GetModuleFileName() [2/2]

int owl::TModule::GetModuleFileName	(	TCHAR *	buff,
		int	maxChars ) const

inline

Returns the expanded file name (path and file name) of the file from which this module was loaded.

buff points to a buffer that holds the path and file name. maxChars specifies the length of the buffer. The expanded filename is truncated if it exceeds this limit. GetModeFileName returns 0 if an error occurs.

Definition at line 1271 of file module.h.

References PRECONDITION.

◆ GetName()

LPCTSTR owl::TModule::GetName ( ) const

inline

Returns the name of the module.

Definition at line 1224 of file module.h.

◆ GetOriginalFilename() [1/2]

bool owl::TModuleVersionInfo::GetOriginalFilename	(	LPCTSTR &	originalFilename,
		uint	lang = 0 )

Retrieves the original filename.

Definition at line 182 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetOriginalFilename() [2/2]

tstring owl::TModuleVersionInfo::GetOriginalFilename ( uint lang = 0 )

Retrieves the original filename.

String version. [VH 2005-04-03]

Definition at line 268 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetOriginalFilename().

◆ GetPointerRepresentation()

auto owl::TWindowClassName::GetPointerRepresentation ( ) const -> LPCTSTR

inline

Definition at line 53 of file module.h.

◆ GetProcAddress()

FARPROC owl::TModule::GetProcAddress ( TNarrowResId id ) const

inline

Returns the entry-point address of the specified exported function if found, otherwise returns NULL.

Definition at line 1281 of file module.h.

References PRECONDITION.

◆ GetProductName() [1/2]

bool owl::TModuleVersionInfo::GetProductName	(	LPCTSTR &	prodName,
		uint	lang = 0 )

Retrieves the product name this module is associated with.

Definition at line 191 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetProductName() [2/2]

tstring owl::TModuleVersionInfo::GetProductName ( uint lang = 0 )

Retrieves the product name this module is associated with.

String version. [VH 2005-04-03]

Definition at line 275 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetProductName().

◆ GetProductVersion() [1/2]

bool owl::TModuleVersionInfo::GetProductVersion	(	LPCTSTR &	prodVersion,
		uint	lang = 0 )

Retrieves the version of the product.

Definition at line 200 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetProductVersion() [2/2]

tstring owl::TModuleVersionInfo::GetProductVersion ( uint lang = 0 )

Retrieves the version of the product.

String version. [VH 2005-04-03]

Definition at line 282 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetProductVersion().

◆ GetProductVersionLS()

uint32 owl::TModuleVersionInfo::GetProductVersionLS ( ) const

inline

Get the minor product version number (last 32-bits).

Definition at line 1454 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetProductVersionMS()

uint32 owl::TModuleVersionInfo::GetProductVersionMS ( ) const

inline

Get the major product version number (first 32-bits).

Definition at line 1445 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetSignature()

uint32 owl::TModuleVersionInfo::GetSignature ( ) const

inline

Definition at line 1411 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ GetSpecialBuild() [1/2]

bool owl::TModuleVersionInfo::GetSpecialBuild	(	LPCTSTR &	debug,
		uint	lang = 0 )

Retrieves the special build number.

Definition at line 209 of file modversi.cpp.

References owl::TModuleVersionInfo::GetInfoString().

◆ GetSpecialBuild() [2/2]

tstring owl::TModuleVersionInfo::GetSpecialBuild ( uint lang = 0 )

Retrieves the special build number.

String version. [VH 2005-04-03]

Definition at line 289 of file modversi.cpp.

References _T, and owl::TModuleVersionInfo::GetSpecialBuild().

◆ GetString()

auto owl::TWindowClassName::GetString ( ) const -> tstring

Returns the class name in string form.

If the class name is represented by an atom, then the Windows API function GetAtomName is called to look up the string associated with the atom.

Definition at line 74 of file module.cpp.

References owl::TWindowClassName::GetAtom(), owl::TWindowClassName::GetPointerRepresentation(), and owl::TWindowClassName::IsString().

◆ GetStrucVersion()

uint32 owl::TModuleVersionInfo::GetStrucVersion ( ) const

inline

Definition at line 1418 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ InfoInferred()

bool owl::TModuleVersionInfo::InfoInferred ( ) const

inline

Definition at line 1492 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ Init() [1/2]

void owl::TModuleVersionInfo::Init ( LPCTSTR modFName )

protected

Definition at line 66 of file modversi.cpp.

References owl::TModuleVersionInfo::Buff, owl::TModuleVersionInfo::FixedInfo, owl::TVersion::GetFileVersionInfo(), owl::TVersion::GetFileVersionInfoSize(), owl::HiUint16(), owl::TModuleVersionInfo::Lang, owl::LoUint16(), owl::MkUint32(), owl::TXModuleVersionInfo::Raise(), and owl::TVersion::VerQueryValue().

◆ Init() [2/2]

void owl::TSystemMessage::Init ( TLangId langId )

protected

Definition at line 127 of file module.cpp.

References _T, owl::TSystemMessage::Error, MAX_PATH, and owl::TSystemMessage::Message.

◆ InitModule()

void owl::TModule::InitModule	(	THandle	hInstance,
		const tstring &	cmdLine )

Finish-up initialization of a module.

Performs any instance initialization necessary for the module.

If the module cannot be created, a TXInvalidModule exception is thrown.

Copies cmd line, and gets proc instance handles for the standard procs.

Definition at line 470 of file module.cpp.

References _T, CHECK, COUNTOF, owl::TApplication::GetCmdLine(), and owl::TModule::SetHandle().

◆ IsAtom()

auto owl::TWindowClassName::IsAtom ( ) const -> bool

inline

Definition at line 55 of file module.h.

◆ IsAvailable()

template<class T >

bool owl::TDllLoader< T >::IsAvailable ( )

static

Load the dll on demand, returning true if it was loaded OK.

Definition at line 498 of file module.h.

◆ IsDebug()

bool owl::TModuleVersionInfo::IsDebug ( ) const

inline

Definition at line 1484 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ IsFileFlagSet()

bool owl::TModuleVersionInfo::IsFileFlagSet ( uint32 flag ) const

inline

Return true if the flag has been set in the version info.

Definition at line 1463 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ IsLoaded()

bool owl::TModule::IsLoaded ( ) const

inline

Returns a nonzero value if the instance handle is loaded.

Use this function primarily to ensure that a given instance is loaded.

Definition at line 1260 of file module.h.

References owl::TModule::GetHandle().

◆ IsPatched()

bool owl::TModuleVersionInfo::IsPatched ( ) const

inline

Definition at line 1500 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ IsPreRelease()

bool owl::TModuleVersionInfo::IsPreRelease ( ) const

inline

Definition at line 1508 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ IsPrivateBuild()

bool owl::TModuleVersionInfo::IsPrivateBuild ( ) const

inline

Definition at line 1516 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ IsRegisteredClass()

auto owl::TModule::IsRegisteredClass ( TWindowClassName name ) const -> bool

Returns true if the given window class has been registered.

See also: GetClassInfo

Definition at line 1008 of file module.cpp.

◆ IsSpecialBuild()

bool owl::TModuleVersionInfo::IsSpecialBuild ( ) const

inline

Definition at line 1524 of file module.h.

References owl::TModuleVersionInfo::FixedInfo, and PRECONDITION.

◆ IsString()

auto owl::TWindowClassName::IsString ( ) const -> bool

inline

Definition at line 54 of file module.h.

◆ LoadAccelerators()

HACCEL owl::TModule::LoadAccelerators ( TResId id ) const

Wrapper for the Windows API.

Loads the accelerator table resource specified by id. LoadAccelerators loads the table only if it has not been previously loaded. If the table has already been loaded, LoadAccelerators returns a handle to the loaded table.

Definition at line 812 of file module.cpp.

References _T, owl::TModule::FindResource(), owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadAccelerators(), owl::TModule::LoadResource(), owl::OWLGetAppDictionary(), PRECONDITION, and WARNX.

◆ LoadBitmap()

HBITMAP owl::TModule::LoadBitmap ( TResId id ) const

Wrapper for the Windows API.

Loads the bitmap resource specified by id. If the bitmap cannot be found, LoadBitmap returns 0.

Definition at line 776 of file module.cpp.

References _T, CHECKX, owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadBitmap(), owl::TModule::LoadResource(), owl::OWLGetAppDictionary(), PRECONDITION, and WARNX.

◆ LoadCursor()

HCURSOR owl::TModule::LoadCursor ( TResId id ) const

Wrapper for the Windows API.

Loads the cursor resource specified by id into memory and returns a handle to the cursor resource. If the cursor resource cannot be found or identifies a resource that is not a cursor, LoadCursor returns 0.

Definition at line 892 of file module.cpp.

References _T, CHECKX, owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadCursor(), owl::TModule::LoadResource(), owl::OWLGetAppDictionary(), PRECONDITION, and WARNX.

◆ LoadHtml()

string owl::TModule::LoadHtml ( TResId id ) const

Loads the given HTML resource and returns it as a narrow string.

It is left to the client to detect the character set and encoding of the contents. If the resource is not found in this module, the module list is tried. If that also fails, an assertion exception is thrown in diagnostics mode. In non-diagnostics mode, an empty string is returned on failure.

Definition at line 971 of file module.cpp.

References _T, CHECK, CHECKX, owl::TModule::FindResourceEx(), owl::TModule::LoadResource(), PRECONDITION, owl::TModule::SizeofResource(), and WARNX.

◆ LoadIcon()

HICON owl::TModule::LoadIcon ( TResId name ) const

Wrapper for the Windows API.

Loads the icon resource indicated by the parameter, name, into memory. LoadIcon loads the icon only if it has not been previously loaded. If the icon resource cannot be found, LoadIcon returns 0.

LoadIcon can be used to load a predefined Windows icon if name points to one of the Windows IDI_XXXX values.

Definition at line 933 of file module.cpp.

References _T, CHECKX, owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadIcon(), owl::TModule::LoadResource(), owl::OWLGetAppDictionary(), PRECONDITION, and WARNX.

◆ LoadMenu()

HMENU owl::TModule::LoadMenu ( TResId id ) const

Wrapper for the Windows API.

Loads the menu resource indicated by id into memory. If the menu resource cannot be found, LoadMenu returns 0.

Definition at line 854 of file module.cpp.

References _T, CHECKX, owl::TModule::FindResource(), owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadMenu(), owl::TModule::LoadResource(), owl::OWLGetAppDictionary(), PRECONDITION, and WARNX.

◆ LoadResource()

HGLOBAL owl::TModule::LoadResource ( HRSRC hRsrc ) const

inline

Wrapper for the Windows API.

Loads a resource indicated by hRsrc into memory and returns a handle to the memory block that contains the resource. If the resource cannot be found, the return value is 0. The hRsrc parameter must be a handle created by FindResource.

LoadResource loads the resource into memory only if it has not been previously loaded. If the resource has already been loaded, LoadResource increments the reference count by one and returns a handle to the existing resource. The resource remains loaded until it is discarded.

Definition at line 1352 of file module.h.

References PRECONDITION.

◆ LoadString() [1/2]

tstring owl::TModule::LoadString ( uint id ) const

Loads a string resource identified by id.

Loads a string resource identified by id

Definition at line 710 of file module.cpp.

References owl::TModule::FindResource(), owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadResource(), and owl::OWLGetAppDictionary().

◆ LoadString() [2/2]

int owl::TModule::LoadString	(	uint	id,
		TCHAR *	buf,
		int	bufSize ) const

Loads a string resource identified by id into the buffer pointed to by buff.

maxChars indicates the size of the buffer to which the zero-terminated string is copied. A string longer than the length specified in maxChars is truncated. The return value is the number of characters copied into the buffer, or 0 if the string resource does not exist.

MAINWIN

Definition at line 586 of file module.cpp.

References _tcsncpy, owl::TModule::FindResource(), owl::TModule::FindResourceEx(), owl::TAppDictionary::GetApplication(), owl::LangNeutral, owl::TModule::LoadResource(), owl::TModule::LoadString(), and owl::OWLGetAppDictionary().

◆ MessageBox()

int owl::TSystemMessage::MessageBox	(	TWindow *	wnd,
		const tstring &	msg,
		const tstring &	title,
		uint	flags = MB_OK ) const

Definition at line 110 of file module.cpp.

References owl::TSystemMessage::Message, owl::TWindow::MessageBox(), and owl::OWLGetAppDictionary().

◆ NextModule()

TModule * owl::TModule::NextModule ( TModule * module = nullptr )

static

Definition at line 290 of file module.cpp.

◆ operator THandle()

owl::TModule::operator TModule::THandle ( ) const

inline

Returns the handle of the application or DLL module represented by this TModule.

The handle must be supplied as a parameter to Windows when loading resources.

Definition at line 1242 of file module.h.

References owl::TModule::GetHandle().

◆ operator==()

bool owl::TModule::operator== ( const TModule & m ) const

inline

Returns true if this instance is equal to the other instance; otherwise, returns false.

Definition at line 1251 of file module.h.

References owl::TModule::GetHandle().

◆ Raise() [1/2]

void owl::TXInvalidModule::Raise ( const tstring & name = tstring() )

static

Throws the exception.

Definition at line 1300 of file module.cpp.

References owl::TXInvalidModule::TXInvalidModule().

◆ Raise() [2/2]

void owl::TXModuleVersionInfo::Raise ( const tstring & name = tstring() )

static

Throws the exception.

Definition at line 422 of file modversi.cpp.

References owl::TXModuleVersionInfo::TXModuleVersionInfo().

◆ SetHandle()

void owl::TModule::SetHandle ( THandle handle )

protected

Set the module instance handle.

Set the instance handle for a module that does not yet have one.

Cannot be called on a module that already has an instance handle.

Definition at line 565 of file module.cpp.

References PRECONDITION.

◆ SetName() [1/2]

void owl::TModule::SetName ( const tstring & name )

String-aware overload.

If an empty string is passed, and the module handle is valid, the name is retrieved using GetModuleFileName.

Definition at line 451 of file module.cpp.

References owl::TModule::GetModuleFileName().

◆ SetName() [2/2]

void owl::TModule::SetName ( LPCTSTR name )

Accessor function that sets the name of the module.

If null-pointer is passed, and the module handle is valid, the name is retrieved using GetModuleFileName.

Definition at line 439 of file module.cpp.

References _T, and owl::TModule::GetModuleFileName().

◆ SizeofResource()

uint32 owl::TModule::SizeofResource ( HRSRC hRsrc ) const

inline

Wrapper for the Windows API.

Returns the size, in bytes, of the resource indicated by hRscr. The resource must be a resource handle created by FindResource. If the resource cannot be found, the return value is 0.

Because of alignment in the executable file, the returned size might be larger than the actual size of the resource. An application cannot rely on SizeofResource for the exact size of a resource.

Definition at line 1369 of file module.h.

References PRECONDITION.

◆ SysError()

uint32 owl::TSystemMessage::SysError ( ) const

inline

Definition at line 1563 of file module.h.

References owl::TSystemMessage::Error.

◆ SysMessage()

const tstring & owl::TSystemMessage::SysMessage ( ) const

inline

Definition at line 1560 of file module.h.

References owl::TSystemMessage::Message.

◆ Throw() [1/2]

void owl::TXInvalidModule::Throw ( )

virtual

Throws the exception.

Reimplemented from owl::TXBase.

Definition at line 1291 of file module.cpp.

◆ Throw() [2/2]

void owl::TXModuleVersionInfo::Throw ( )

virtual

Throws the exception.

Reimplemented from owl::TXBase.

Definition at line 413 of file modversi.cpp.

Variable Documentation

◆ Buff

uint8* owl::TModuleVersionInfo::Buff

protected

new'd File version info buffer

Definition at line 285 of file module.h.

◆ Error

uint32 owl::TSystemMessage::Error

protected

Definition at line 342 of file module.h.

◆ FixedInfo

VS_FIXEDFILEINFO* owl::TModuleVersionInfo::FixedInfo

protected

Fixed file info structure.

Definition at line 287 of file module.h.

◆ Lang

uint32 owl::TModuleVersionInfo::Lang

protected

Default language translation.

Definition at line 286 of file module.h.

◆ Message

tstring owl::TSystemMessage::Message

protected

Definition at line 343 of file module.h.

Friends

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const TModule &	m )

friend

Definition at line 1647 of file module.cpp.

Classes

Typedefs

Enumerations

Functions

Variables

Friends

Get & set members. Use these instead of directly accessing members

Windows HINSTANCE/HMODULE related API functions encapsulated

Global search for resources

Detailed Description

Typedef Documentation

◆ THandle

Enumeration Type Documentation

◆ TFileOS

◆ TFileSubType

◆ TFileType

Function Documentation

◆ TDllLoader()

◆ TErrorMode()

◆ TModule() [1/5]

◆ TModule() [2/5]

◆ TModule() [3/5]

◆ TModule() [4/5]

◆ TModule() [5/5]

◆ TModuleVersionInfo() [1/2]

◆ TModuleVersionInfo() [2/2]

◆ TSystemMessage() [1/2]

◆ TSystemMessage() [2/2]

◆ TWindowClassName() [1/2]

◆ TWindowClassName() [2/2]

◆ TXInvalidModule()

◆ TXModuleVersionInfo()

◆ ~TDllLoader()

◆ ~TErrorMode()

◆ ~TModule()

◆ ~TModuleVersionInfo()

◆ Clone() [1/2]

◆ Clone() [2/2]

◆ CopyIcon()

◆ Dll()

◆ Error()

◆ FindResModule()

◆ FindResource()

◆ FindResourceEx()

◆ GetAtom()

◆ GetClassInfo() [1/2]

◆ GetClassInfo() [2/2]

◆ GetFileDate()

◆ GetFileDescription() [1/2]

◆ GetFileDescription() [2/2]

◆ GetFileFlags()

◆ GetFileFlagsMask()

◆ GetFileOS()

◆ GetFileSubType()

◆ GetFileType()

◆ GetFileVersion() [1/2]

◆ GetFileVersion() [2/2]

◆ GetFileVersionLS()

◆ GetFileVersionMS()

◆ GetFixedInfo()

◆ GetHandle()

◆ GetInfoString() [1/2]

◆ GetInfoString() [2/2]

◆ GetInternalName() [1/2]

◆ GetInternalName() [2/2]

◆ GetLanguage()

◆ GetLanguageName() [1/2]

◆ GetLanguageName() [2/2]

◆ GetLegalCopyright() [1/2]

◆ GetLegalCopyright() [2/2]

◆ GetModuleFileName() [1/2]

◆ GetModuleFileName() [2/2]

◆ GetName()

◆ GetOriginalFilename() [1/2]

◆ GetOriginalFilename() [2/2]

◆ GetPointerRepresentation()

◆ GetProcAddress()

◆ GetProductName() [1/2]

◆ GetProductName() [2/2]

◆ GetProductVersion() [1/2]