JCL Help:RegReadBinary

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Reads binary data from the registry.


Pascal

 function RegReadBinary(const RootKey: DelphiHKEY; const Key: string; const Name: string; var Value; const ValueSize: Cardinal): Cardinal;
function RegReadBinaryDef(const RootKey: DelphiHKEY; const Key: string; const Name: string; var Value; const ValueSize: Cardinal; const Def: Byte): Cardinal;


Parameters

Parameters Description
const RootKey: DelphiHKEY The rootkey from which to read, one of the HKEY_XXX constants.
const Key: string The key (path) where the desired value is located, relative to RootKey.
const Name: string Name of the value to read.
var Value Destination for the data of any type.
const ValueSize: Cardinal Size of Value in bytes.


Return Value

The return value is not the data itself but the amount of data read. The value is never bigger than ValueSize.


Description

RegReadBinary reads binary data from the registry. Value is untyped to allow to hand in a variable of any type. ValueSize should give the size of Value in bytes. The function accepts only key values of type REG_BINARY. If the function fails it raises an EJclRegistryError exception.


See Also

RegReadBool RegReadInteger RegReadString


About

Unit

JclRegistry


Donator

Stephane Fillon


Contributors

Anonymous


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page