SAXO Documentation Assistant: Overview

ToBeReviewed/STRING/

string2struct.pro

This is a really, really cool way to turn keywords into a structure. Takes an input string set up as keywords and returns an anonymous structure. This is particularly useful for taking keywords entered by a user in a text field and passing then to other routines.

too_cool

result = too_cool(_EXTRA=_EXTRA)

Return value

Keywords

_EXTRA

Used to pass keywords

Examples

Version history

Version

$Id: string2struct.pro 232 2007-03-20 16:59:36Z pinsard $

History

Known issues

Restrictions

string2struct Utilities

result = string2struct(strVal)

Return value

This function returns the string as an anonymous structure. If an error was found then this function returns a structure with a null field.

Parameters

strVal in required

String set up as keywords. Keywords require a little special treatment. Such as plot,findgen(100),_extra=stringToStructure('title="testing"')

Examples

       The code below creates a widget that uses this routine.
       pro tPlot,event
       widget_control,event.top,get_uvalue=field
       widget_control,field,get_value=strVal
       extra = stringToStructure(strVal)
       plot,findgen(100),_extra=extra
       wshow
       return
       end

       pro testWid
       ;enter any keyword to plot and see how it works
       base = widget_base(/col)
       field = cw_field(base,title='test',value='ax=0',/string)
       void = widget_button(base,value='plot',event_pro='tPlot')
       widget_control,base,/realize,set_uvalue=field
       xmanager,'testWid',base,/no_block
       return
       end

Version history

Version

$Id: string2struct.pro 232 2007-03-20 16:59:36Z pinsard $

History

Written by: RLK, Ronn Kling Consulting. ronn@rlkling.com www.rlkling.com May, 1999

Produced by IDLdoc 2.0.