home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc / Developer Documentation / Recipes, Tech Notes & Articles / Tech Notes / Utilities Documentation / BndNSUtil < prev    next >
Encoding:
Text File  |  1996-07-24  |  2.2 KB  |  39 lines  |  [TEXT/ttxt]
  1. OpenDoc™ Utilities Documentation
  2.  
  3. Binding Namespace Utilities
  4. by The OpenDoc Design Team
  5.  
  6. © 1996  Apple Computer, Inc. All Rights Reserved.
  7. Apple, the Apple logo, and Macintosh are registered trademarks of Apple Computer, Inc.
  8. Mac and OpenDoc are trademarks of Apple Computer, Inc.
  9.  
  10.  
  11. Introduction
  12.  
  13. The only functions in BndNSUtil safe for parts to call are GetUserKindFromKind, GetUserEditorFromEditor, and GetUserCatFromCat to get the user visible string for a Kind, Editor, or Category respectively.  With the exception of InitBindingNamespaceUtils, all other functions in this file are obsolete (won't work for parts) or are deprecated (might work but will definitively be obsoleted in the future).
  14.  
  15. DO NOT CALL ANY ROUTINES IN BndNSUtil.cpp OTHER THAN GetUserKindFromKind, GetUserEditorFromEditor, GetUserCatFromCat, or InitBindingNamespaceUtils. ALL OTHER ROUTINES in BndNSUtils WILL BREAK IN FUTURE VERSIONS OF OPENDOC.
  16.  
  17. Binding Namespace Utilities
  18.  
  19. void InitBindingNamespaceUtils(ODSession* session)
  20.  
  21. New in OD 1.1, you must call this before calling any of the routines in BndNSUtil.cpp that take an ODNameSpaceManager* param. The functionality of the BndNSUtil routines have been reimplemented as methods on the ODBinding object.
  22. The new implementations in BndNSUtil  will work  but you should really be calling the new ODBinding API directly.
  23. If you want to use the reimplemented routines here to afford a degree of source compatibility, you must first call InitBindingNamespaceUtils.
  24.  
  25. ODBoolean GetUserKindFromKind( ODNameSpaceManager* theNmSpcMgr, 
  26.                                     ODType kind, ODName** name )
  27.  
  28. Returns true if it finds a user string associated with kind. On return it places the user string  if found or kODNULL in name.
  29.  
  30. ODBoolean GetUserEditorFromEditor( ODNameSpaceManager* theNmSpcMgr, 
  31.                                     ODEditor editor, ODName** name )
  32.  
  33. Returns true if it finds a user string associated with editor (SOM Class ID). On return it places the user string  if found  or kODNULL  in name.
  34.  
  35. ODBoolean GetUserCatFromCat( ODNameSpaceManager* theNmSpcMgr, 
  36.                                     ODType category, ODName** name )
  37.  
  38. Returns true if it finds a user string associated with category. On return it places the user string  if found  or kODNULL  in name.
  39.