Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31559 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

							       SoSFString(3IV)

NAME
     SoSFString (SoSString) - field containing a string

INHERITS FROM
     SoField > SoSField > SoSFString

SYNOPSIS
     #include <Inventor_c/fields/SoSFString.h>

     typedef SoSFString	 SoSString

	  Functions from class SoSFString:

			 SoSStringSetStr(SoSString *this, const char *string)
     SoType		 SoSStringGetClassTypeId()
     void		 SoSStringGetTypeId(const SoSString *this)
     const SbString *	 SoSStringGet(const SoSString *this)
     void		 SoSStringSet(SoSString *this, const SbString *
			      newValue)
     int		 SoSStringIsEq(const SoSString *this, const SoSFString
			      *f)
     int		 SoSStringIsNEq(const SoSString *this, const
			      SoSFString *f)

	  Functions from class SoField:

     void		 SoSStringSetIgnored(SoSString *this, SbBool ignore)
     SbBool		 SoSStringIsIgnored(const SoSString *this)
     SbBool		 SoSStringIsDflt(const SoSString *this)
     SbBool		 SoSStringIsOfType(const SoSString *this, SoType type)
     SbBool		 SoSStringSetFromStr(SoSString *this, const char
			      *valueString)
     void		 SoSStringGetIntoStr(SoSString *this, SbString
			      *valueString)
     void		 SoSStringTouch(SoSString *this)
     SbBool		 SoSStringConnFromField(SoSString *this, SoField
			      *fromField)
     SbBool		 SoSStringConnFrom(SoSString *this, SoEngineOutput
			      *fromEngine)
     void		 SoSStringDisconn(SoSString *this)
     SbBool		 SoSStringIsConn(const SoSString *this)
     SbBool		 SoSStringIsConnFromField(const SoSString *this)
     SbBool		 SoSStringGetConnField(const SoSString *this, SoField
			      **writingField)
     SbBool		 SoSStringIsConnFromEngine(const SoSString *this)
     SbBool		 SoSStringGetConnEngine(const SoSString *this,
			      SoEngineOutput **engineOutput)
     void		 SoSStringEnableConn(SoSString *this, SbBool flag)
     SbBool		 SoSStringIsConnEnabled(const SoSString *this)
     int		 SoSStringGetForwardConn(const SoSString *this,
			      SoFieldList *list)

Page 1

SoSFString(3IV)

     SoFieldContainer *	 SoSStringGetContainer(const SoSString *this)

DESCRIPTION
     A field containing an ASCII string (sequence of characters). Inventor
     does not support non-ASCII strings.

     SoSFStrings are written to file as a sequence of ASCII characters in
     double quotes (optional if the string doesn't contain any whitespace).
     Any characters (including newlines) may appear within the quotes. To
     include a double quote character within the string, precede it with a
     backslash. For example:

	  Testing
	  "One, Two, Three"
	  "He said, \"Immel did it!\""

     are all valid strings.

FUNCTIONS
			 SoSStringSetStr(SoSString *this, const char *string)
	  Convenience method to set the field's value given a character array.

     SoType		 SoSStringGetClassTypeId()
     void		 SoSStringGetTypeId(const SoSString *this)
	  Returns the type for this class or a particular object of this
	  class.

     const SbString *	 SoSStringGet(const SoSString *this)
	  Returns this field's value.

     void		 SoSStringSet(SoSString *this, const SbString *
			      newValue)
	  Sets this field to newValue.

     int		 SoSStringIsEq(const SoSString *this, const SoSFString
			      *f)
     int		 SoSStringIsNEq(const SoSString *this, const
			      SoSFString *f)
	  Returns TRUE if f is of the same type and has the same value as this
	  field.

SEE ALSO
     SbString, SoField, SoSField, SoMFString

Page 2

Vote for polarhome