IVisualizationStyle.GetString (METH)ΒΆ

METHOD GetString : POINTER TO STRING

This method searches for a style entry of type STRING and returns the according value if found. The returned pointer to a string might point to values that are larger than 80 characters!

InOut:

Scope

Name

Type

Comment

Return

GetString

POINTER TO STRING

Input

stStyleKey

STRING

The name of the style entry to seach for.

pstDefault

POINTER TO STRING

The default value to use if the entry is not found. In case of a NULL value passed here, an empty string will be returned as default!

pOptResult

POINTER TO UDINT

An optional result error code. Common result values are Errors.ERR_OK if a valid style was found or Errors.ERR_INVALIDID if no style entry was found. In this case, the method will return the default value.