Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Novlib 3.30 Online Reference - <b> itmprpstrget() / itmprpstrset()</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 ItmPrpStrGet() / ItmPrpStrSet()
------------------------------------------------------------------------------
 Warning:
 USE WITH EXTREME CAUTION.

 Serious damage can be done to the bindery if misused.

 Purpose:
 Get / set an item property value as a string.

 Syntax:
 lpszValue = ItmPrpStrGet(lpszObjName,iObjType,lpszPropName,iSegment)
 lpszValue = ItmPrpStrSet(lpszObjName,iObjType,lpszPropName,iSegment,
             lpszNewValue )

 Parameters:
 lpszObjName  The object name.
 iObjType     The object type.
 lpszPropName The property name.
 iSegment     The segment number.
 lpszNewValue The new property value.

 Returns:
 A character string of up to 128 characters.

 Description:
 ItmPrpStrGet() returns a string containing the specified property
 value up to and including the first NULL character. lpszObjName is the
 object name and iObjType its type. lpszPropName is the property name and
 iSegment is the segment.

 ItmPrpStrSet() sets the property value to lpszNewValue and returns
 the previous setting if successful or an empty string if an error occurs.
 Property values are split into segments of 128 bytes each. While many are
 stored in binary form, some properties, such as IDENTIFICATION contain
 information in NULL terminated string form.

 These functions should only be used to manipulate properties that are
 stored in NULL terminated string form. The functions ItmPrpValGet()
 and ItmPrpValSet() should be used for manipulating binary property
 values.

 Example:
 // To change the full name of user JIM to Jim Smith, which
 // will be a string contained in segment 1 of a property called
 // IDENTIFICATION:
 lpszOldName = ItmPrpStrSet("JIM", OT_USER,"IDENTIFICATION",;
               1,"Jim Smith" )
 lpszNewName = ItmPrpStrGet("JIM", OT_USER,"IDENTIFICATION",1)
 if ( !empty( lpszNewName ) )
    ? "User JIM's full name is now", NewName
 endif

 Notes:
 For more information on properties and their values, see Bindery
 Functions, Chapter 3.

 May require Supervisor equivalence.

See Also: ItmPrpBytGet() / ItmPrpBytSet() ItmPrpValGet() / ItmPrpValSet() ObjPrpLst()

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson