System.VarUtils.VarBstrFromBool

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

VarBstrFromBool: function(boolIn: WordBool; LCID: Integer; dwFlags: Integer;
out bstrOut: WideString): HRESULT; stdcall;

C++

extern DELPHI_PACKAGE HRESULT __stdcall (*VarBstrFromBool)(System::WordBool boolIn, int LCID, int dwFlags, /* out */ System::WideString &bstrOut);

Properties

Type Visibility Source Unit Parent
variable public
System.VarUtils.pas
System.VarUtils.hpp
System.VarUtils System.VarUtils

Description

VarBstrFromBool is used to specify the function that makes the conversion from a boolean value to a WideString.

Use VarBstrFromBool to specify the function that makes the conversion from the boolean value given through boolIn to the WideString stored in bstrOut. The LCID parameter is a locale identifier and dwFlags specifies the flags used in the conversion.

The function stored in VarBstrFromBool returns the result of the conversion operation, which can be one of the following.



Value Meaning

VAR_OK

The conversion was successful.

VAR_BADVARTYPE

The variant type of the input parameter is not valid.

VAR_OVERFLOW

The data stored in the output parameter does not fit in the destination type.

VAR_TYPEMISMATCH

The argument cannot be cast to the specified type.

VAR_INVALIDARG

Either one of the arguments is invalid.

VAR_OUTOFMEMORY

There is not enough memory to complete the conversion.



To make the inverse conversion, from a WideString to a boolean value, use the function referenced by VarBoolFromStr.

See Also