|
(SST) ShlWAPIFunctionInfo Version 1.0 |
|---|---|
| Developer Reference |
| Function that retrieves the string returned when reading property ResourceFileVersion. |
| Scope |
|---|
| Protected (i.e. the method can only be accessed from code in a descendant class or the unit it which it is implemented). |
| Syntax | |
|---|---|
| Function RetResourceFileVersion() : STRING; | |
| Parameters | |
|---|---|
| None | |
| Return Values |
|---|
|
Returns the string extracted from the version information resources in the file specified in property DllFileName, provided the file contains a "VERSIONINFO" resource block/section and a value-string was assigned to the predefined "FileVersion" string-name in the resource definition file.
The function returns an empty string if the file was linked without version information resources,
the "FileVersion" member/field was left empty by the publisher of the file, or an error occurred during execution.
|
| Remarks |
|---|
| If the function returns an empty string due to an error, the class' LastError property may contain pertinent information on the nature of the fault in form of a Windows error code. |
| The function forms the sub-block, path string required to extract the actual resource, value string from hard-coded strings and property ResourceLanguageIdAsStr. It then calls function WinApiVerQueryValueStr with the resulting, concatenated string as the parameter. |
| The function always returns the version information of the first (i.e. the primary) language id. |
| Requirements | |
|---|---|
| Unit | (Declared and implemented in) SSTNewUnit.pas |
| Library | SSTNewUnit.dcu/SSTNewUnit.obj |
| Unicode | Implemented as ANSI version only. |
| See Also |
|---|
|
TSSTDllVerInfo,
ResourceFileVersion,
DllFileName,
LastError,
WinApiVerQueryValueStr,
|
| Windows APIs:
|
|
Document/Contents version 1.00 Page/URI last updated on April 28, 2022 |
Copyright © Stoelzel Software Technologie (SST) 2010 - 2017 |
Suggestions and comments mail to: webmaster@stoelzelsoftwaretech.com |