GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Sixteen — Application (continued)

RegistryGet32Word Function

Overview

The RegistryGet32Word function returns the value as specified by the key location and name as a 32-bit dword.

Syntax/Parameters

Syntax

dword = RegistryGet32Word ( string key, string name );

Parameters

key

A string containing the name of the key to access.

name

A string containing the name of value to access. If the value is an empty string, the default value for the key is returned.

Return Value

A dword containing the data or zero on failure. Since zero can be returned, the last error must be checked using the GetLastError or IsError functions.

Typical underlying errors codes are ERROR_PATH_NOT_FOUND (3) when the key is not found and ERROR_FILE_NOT_FOUND (2) and the value name is not found.

Remarks

If the data type cannot be converted, ERROR_CONTEXT will be returned as the error code. Note that the raw underlying type is an unsigned 32-bit dword and if the value is converted to a 64-bit long integer, the sign will not extend. The REG_QWORD type will not be converted to 32-bits.

The script/user must have access rights to the specified key and value.

Related Functions

RegistryEnumerateNames — Enumerates all the value names for specified key node.

RegistryGet64Word — Returns the value of a specified key as a 64-bit numeric value.

RegistryGetBlock — Returns a binary block of information into the specified data parameter.

RegistryGetFloat — Accesses a key value as a 64-bit REG_QWORD and converts it to a float.

RegistryGetString — Returns the value of a specified key as a string.

RegistryGetType — Returns the type of data for the associated value name.

RegistrySetValue — Sets the value of a specified key to the variable or value provided.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.