(SST) ShlWAPIFunctionInfo TSSTDllVerInfo.ResourcePrivateBuild Property

	(SST) ShlWAPIFunctionInfo Version 1.0

Developer Reference

(SST) ShlWAPIFunctionInfo Version 1.0

Developer Reference

Property TSSTDllVerInfo.ResourcePrivateBuild
Specifies the string assigned to the standardized, predefined, PrivateBuild, resource string-name in the version information resources of the executable specified by property DllFileName.

Property TSSTDllVerInfo.ResourcePrivateBuild

Specifies the string assigned to the standardized, predefined, PrivateBuild, resource string-name in the version information resources of the executable specified by property DllFileName.

Scope
Public (i.e. this property can be referenced from any code, including that in other units, with access to the TSSTDllVerInfo object of interest).

Scope

Public (i.e. this property can be referenced from any code, including that in other units, with access to the TSSTDllVerInfo object of interest).

Syntax
Property ResourcePrivateBuild : STRING READ RetResourcePrivateBuild;

Syntax

Property ResourcePrivateBuild : STRING READ RetResourcePrivateBuild;

Values
This property is an ANSI representation of the of the Unicode, resource string assigned to the predefined, PrivateBuild, resource string-name.

Values

This property is an ANSI representation of the of the Unicode, resource string assigned to the predefined, PrivateBuild, resource string-name.

Remarks
This property is a read-only property.
Read this property to retrieve the description of the particularities that distinguish the executable specified in DllFileName from the normal build.
According to the Microsoft programming guidelines, the PrivateBuild resource string should only be defined and authored if the VS_FF_PRIVATEBUILD flag in the dwFileFlags member of the VS_FIXEDFILEINFO record/structure is set. Consequently, if the flag is not set, the property should not return the corresponding value-string (i.e. the PrivateBuild, version information string should be ignored). This. also. being the currently implemented, default behaviour of the property. However, it is very easy to unintentionally author and link version information resources that are not compliant with this requirement. As this leads to a conflict in deciding whether TSSTDllVerInfo should return the string assigned to the string-name, in such cases, or not, we have provided suggestions on how to implement an alternative behaviour in the remarks section of the read, access specifier, method RetResourceSpecialBuild.
The string is retrieved from the in-memory copy of the version information resources, (previously) extracted by RetResourceVersionInfo from the file specified by DllFileName.
The Unicode to ANSI conversion is performed by the invoked Winodws API function(s).

Example
For an example on how to implement code that uses this property, please refer to TSSTDllVerInfo Class page or function/method TForm1.LogDllVersionInfo in the source code of the main window unit of the ShlWAPIFunctionInfo project.

Example

    For an example on how to implement code that uses this property, please refer to
    TSSTDllVerInfo Class page or function/method TForm1.LogDllVersionInfo in the
source code of the main window unit of the ShlWAPIFunctionInfo project.
    

Requirements
Unit	(Declared and implemented in) SSTNewUnit.pas
Library	SSTNewUnit.dcu/SSTNewUnit.obj
Unicode	Implemented as ANSI version only.

Requirements

Unit

(Declared and implemented in) SSTNewUnit.pas

Library

SSTNewUnit.dcu/SSTNewUnit.obj

Unicode

Implemented as ANSI version only.

See Also
TSSTDllVerInfo, DllFileName, RetResourcePrivateBuild, ResourceVersionInfo, ResourceFixedFileInfo, LastError, Source Code.

Windows APIs: VERSIONINFO Resource, VS_FIXEDFILEINFO Structure, VerQueryValue, GetLastError.