GetDataSize Method (fieldName)

From DTF API

previous page next page

Deployment Tools Foundation GetDataSize Method (fieldName)

Gets the length of a record field. The count does not include the terminating null.

Declaration Syntax

Visual Basic

Visual C++

public int GetDataSize(
	string fieldName
)

Public Function GetDataSize ( 
	fieldName As String
) As Integer

public:
int GetDataSize(
	String^ fieldName
)

member GetDataSize : 
        fieldName : string -> int

Parameters

fieldName (String): Specifies the field to check.

Return Value

Int32

Remarks

The returned data size is 0 if the field is null, non-existent, or an internal object pointer. The method also returns 0 if the handle is not a valid Record handle.

If the data is in integer format, the property returns 2 or 4.

If the data is in string format, the property returns the character count (not including the NULL terminator).

If the data is in stream format, the property returns the byte count.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The field name does not match any of the named fields in the Record.

Assembly: Microsoft.Deployment.WindowsInstaller (Module: Microsoft.Deployment.WindowsInstaller.dll) Version: 3.0.0.0 (3.11.1.2318)

previous page start next page