home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Windows Gam…ming Gurus (2nd Edition) / Disc2.iso / msdn_vcb / samples / vc98 / sdk / com / oleaut / browseh / browseh.odl < prev    next >
Encoding:
Text File  |  1997-09-30  |  13.5 KB  |  425 lines
  1. /*************************************************************************
  2. **
  3. **    OLE Automation BrowseHelper Object.
  4. **
  5. **    browseh.odl
  6. **
  7. **    Object Description source file.
  8. **
  9. **     Written by Microsoft Product Support Services, Windows Developer Support
  10. **    (c) Copyright Microsoft Corp. 1994 All Rights Reserved
  11. **
  12. *************************************************************************/ 
  13.  
  14.  
  15. [
  16.   uuid(19FEEEC0-4104-101B-B826-00DD01103DE1),              // LIBID_BrowseHelper
  17.   helpstring("BrowseHelper 1.0 Type Library"),
  18.   version(1.0)
  19. ] 
  20. library BrowseHelper
  21. {
  22. #ifdef WIN32
  23.     importlib("stdole2.tlb");
  24. #else
  25.     importlib("stdole.tlb");
  26. #endif 
  27.     importlib("mydisp.tlb"); 
  28.     
  29.     // Forward declarations      
  30.     interface IArrayDesc;   
  31.     
  32.     typedef enum {
  33.        TYPE_FUNCTION = 0,
  34.        TYPE_PROPERTY = 1,
  35.        TYPE_CONSTANT = 2,
  36.        TYPE_PARAMETER = 3
  37.    } OBJTYPE;
  38.  
  39.     
  40.     [
  41.       uuid(19FEEECC-4104-101B-B826-00DD01103DE1),          // IID_ICollection                
  42.       helpstring("Generic collection."),
  43.       odl
  44.     ]
  45.     interface ICollection : CMyDispatch                         
  46.     {                
  47.       [propget, helpstring("Returns number of items in collection.")]
  48.       long Count();
  49.  
  50.       [propget, id(0), helpstring("Given an integer index, returns one of the items in the collection")]
  51.       IDispatch * Item([in] long Index);
  52.                         
  53.       [propget, restricted, id(-4)]    // -4 is DISPID_NEWENUM. Must be propget.
  54.       IUnknown * _NewEnum();           
  55.     }  
  56.         
  57.     [
  58.       uuid(19FEEEC3-4104-101B-B826-00DD01103DE1),          // IID_ITypeLibrary                    
  59.       helpstring("TypeLibrary object."),
  60.       odl
  61.     ]
  62.     interface ITypeLibrary : CMyDispatch                         
  63.     {
  64.       [propget, helpstring("Returns the name.")]
  65.       BSTR Name(void);
  66.         
  67.       [propget, helpstring("Returns the documentation string.")]
  68.       BSTR Documentation(void);
  69.         
  70.       [propget, helpstring("Returns the help context.")]
  71.       long HelpContext(void);
  72.         
  73.       [propget, helpstring("Returns the help file.")]
  74.       BSTR HelpFile(void);
  75.       
  76.       [propget, helpstring("Returns Locale ID.")]
  77.       long LocaleID(void);  
  78.       
  79.       [propget, helpstring("Returns Major Version.")]
  80.       int MajorVersion(void);
  81.       
  82.       [propget, helpstring("Returns Minor Version.")]
  83.       int MinorVersion(void);
  84.         
  85.       [propget, helpstring("Returns collection of TypeInfos.")]
  86.       ICollection* TypeInfos(void);
  87.       
  88.       [propget, helpstring("Returns GUID as a string.")]
  89.       BSTR GUIDAsString(void);
  90.     }      
  91.     
  92.     [
  93.       uuid(19FEEEC4-4104-101B-B826-00DD01103DE1),          // IID_ITypeInformation                    
  94.       helpstring("TypeInfo object."),
  95.       odl
  96.     ]
  97.     interface ITypeInformation : CMyDispatch                         
  98.     {
  99.       [propget, helpstring("Returns the name.")]
  100.       BSTR Name(void);
  101.         
  102.       [propget, helpstring("Returns the documentation string.")]
  103.       BSTR Documentation(void);
  104.         
  105.       [propget, helpstring("Returns the help context.")]
  106.       long HelpContext(void);
  107.         
  108.       [propget, helpstring("Returns the help file.")]
  109.       BSTR HelpFile(void);
  110.       
  111.       [propget, helpstring("Returns TYPEKIND.")]
  112.       TYPEKIND TypeInfoKind(void);
  113.  
  114.       [propget, helpstring("Returns TYPEFLAGS")]
  115.       short TypeFlags();
  116.  
  117.       [propget, helpstring("Returns GUID as a string.")]
  118.       BSTR GUIDAsString(void);
  119.       
  120.       HRESULT _InitTypeInfo([in]LPTYPEINFO ptinfo);                                                              
  121.     }
  122.     
  123.     [
  124.       uuid(19FEEEC2-4104-101B-B826-00DD01103DE1),          // IID_IBrowseHelper               
  125.       helpstring("BrowseHelper object."),
  126.       odl
  127.     ]
  128.     interface IBrowseHelper : CMyDispatch                         
  129.     {
  130.       [helpstring("Opens and browses the specified type library and returns TypeLibrary object")]
  131.       ITypeLibrary* BrowseTypeLibrary([in] BSTR TypeLibraryPath);                                    
  132.     }  
  133.  
  134.     
  135.     [
  136.       uuid(19FEEED1-4104-101B-B826-00DD01103DE1),          // IID_ITypeDesc                  
  137.       helpstring("TypeDescription object."),
  138.       odl
  139.     ]
  140.     interface ITypeDesc : CMyDispatch                         
  141.     {        
  142.       [propget, helpstring("Returns the type as VARTYPE.")]
  143.       short Type(void);
  144.       
  145.       [propget, helpstring("Returns a TypeInformation object with more information about the VT_USERDEFINED type.")]
  146.       ITypeInformation* UserDefinedDesc(void);    
  147.       
  148.       [propget, helpstring("Returns an ArrayDesc with more information about the VT_CARRAY type.")]
  149.       IArrayDesc* ArrayDesc(void);
  150.         
  151.       [propget, helpstring("Returns a TypeDesc object with more information about the VT_PTR type.")]
  152.       ITypeDesc* PointerDesc(void);
  153.     } 
  154.     
  155.     [
  156.       uuid(19FEEED3-4104-101B-B826-00DD01103DE1),          // IID_IArrayBound                
  157.       helpstring("ArrayBound object."),
  158.       odl
  159.     ]
  160.     interface IArrayBound : CMyDispatch                         
  161.     {        
  162.       [propget, helpstring("Number of elements in this dimension of the array.")]
  163.       long ElementsCount(void); 
  164.       
  165.       [propget, helpstring("Lower bound in this dimension of the array.")]
  166.       long LowerBound(void);
  167.     } 
  168.     
  169.         
  170.     [
  171.       uuid(19FEEED2-4104-101B-B826-00DD01103DE1),          // IID_IArrayDesc                 
  172.       helpstring("ArrayDesc object."),
  173.       odl
  174.     ]
  175.     interface IArrayDesc : CMyDispatch                         
  176.     {        
  177.       [propget, helpstring("Returns the array element type.")]
  178.       ITypeDesc* ElementType(void); 
  179.       
  180.       [propget, helpstring("Returns a collection of array bounds.")]
  181.       ICollection* ArrayBounds(void);
  182.     } 
  183.     
  184.     [
  185.       uuid(19FEEEC5-4104-101B-B826-00DD01103DE1),          // IID_IInterface                    
  186.       helpstring("Interface object."),
  187.       odl
  188.     ]
  189.     interface IInterface : ITypeInformation                     
  190.     {      
  191.       [propget, helpstring("Returns collection of functions.")]
  192.       ICollection* Functions(void);
  193.  
  194.       [propget, helpstring("Returns base interface.")]
  195.       IInterface* BaseInterface(void);
  196.     } 
  197.     
  198.     [
  199.       uuid(19FEEEC6-4104-101B-B826-00DD01103DE1),          // IID_IDispinterface                    
  200.       helpstring("Dispinterface object."),
  201.       odl
  202.     ]
  203.     interface IDispinterface : ITypeInformation                     
  204.     {
  205.       [propget, helpstring("Returns collection of properties.")]
  206.       ICollection* Properties(void);
  207.         
  208.       [propget, helpstring("Returns collection of methods.")]
  209.       ICollection* Methods(void);
  210.  
  211.       [propget, helpstring("Return Interface part of dual interface, if this is a dual interface.")]
  212.       IInterface* Interface(void);
  213.     }  
  214.     
  215.     [
  216.       uuid(19FEEEC7-4104-101B-B826-00DD01103DE1),          // IID_IModule                   
  217.       helpstring("Module object."),
  218.       odl
  219.     ]
  220.     interface IModule : ITypeInformation                     
  221.     {      
  222.       [propget, helpstring("Returns collection of functions.")]
  223.       ICollection* Functions(void);
  224.     }  
  225.     
  226.     [
  227.       uuid(19FEEEC8-4104-101B-B826-00DD01103DE1),          // IID_ICoClass                    
  228.       helpstring("CoClass object."),
  229.       odl
  230.     ]
  231.     interface ICoClass : ITypeInformation                         
  232.     {
  233.       [propget, helpstring("Returns collection of interfaces/dispinterfaces.")]
  234.       ICollection* Interfaces(void);        
  235.     } 
  236.     
  237.     [
  238.       uuid(19FEEECD-4104-101B-B826-00DD01103DE1),          // IID_IEnum                  
  239.       helpstring("Enum object."),
  240.       odl
  241.     ]
  242.     interface IEnum : ITypeInformation                         
  243.     {
  244.       [propget, helpstring("Returns collection of enumerated elements.")]
  245.       ICollection* Elements(void);       
  246.     }   
  247.     
  248.     [
  249.       uuid(19FEEECE-4104-101B-B826-00DD01103DE1),          // IID_IStruct                  
  250.       helpstring("Struct object."),
  251.       odl
  252.     ]
  253.     interface IStruct : ITypeInformation                         
  254.     {
  255.       [propget, helpstring("Returns collection of structure members.")]
  256.       ICollection* Members(void);       
  257.     }  
  258.     
  259.     [
  260.       uuid(19FEEECF-4104-101B-B826-00DD01103DE1),          // IID_IStruct                  
  261.       helpstring("Struct object."),
  262.       odl
  263.     ]
  264.     interface IUnion : ITypeInformation                         
  265.     {
  266.       [propget, helpstring("Returns collection of union members.")]
  267.       ICollection* Members(void);       
  268.     }    
  269.     
  270.     [
  271.       uuid(19FEEED0-4104-101B-B826-00DD01103DE1),          // IID_IAlias                 
  272.       helpstring("Alias object."),
  273.       odl
  274.     ]
  275.     interface IAlias : ITypeInformation                         
  276.     {
  277.       [propget, helpstring("Returns Base Type.")]
  278.       ITypeDesc* BaseType();       
  279.     }                                                                     
  280.     
  281.     [
  282.       uuid(19FEEEC9-4104-101B-B826-00DD01103DE1),          // IID_IFunction                    
  283.       helpstring("Function object."),
  284.       odl
  285.     ]
  286.     interface IFunction : CMyDispatch                         
  287.     {
  288.       [propget, helpstring("Returns name.")]
  289.       BSTR Name();   
  290.       
  291.       [propget, helpstring("Returns the documentation string.")]
  292.       BSTR Documentation(void);
  293.         
  294.       [propget, helpstring("Returns the help context.")]
  295.       long HelpContext(void);
  296.         
  297.       [propget, helpstring("Returns the help file.")]
  298.       BSTR HelpFile(void);
  299.       
  300.       [propget, helpstring("Returns a ITypeDesc object that describes the return type of function.")]
  301.       ITypeDesc* ReturnType();
  302.       
  303.       [propget, helpstring("Returns collection of parameters of function.")]
  304.       ICollection* Parameters(); 
  305.       
  306.       [propget, helpstring("Returns Memid (Also called DISPID).")]
  307.       MEMBERID Memberid(); 
  308.       
  309.       [propget, helpstring("Returns calling convention.")]
  310.       CALLCONV CallConvention();
  311.       
  312.       [propget, helpstring("Returns FUNCKIND.")]
  313.       FUNCKIND FuncKind();
  314.       
  315.       [propget, helpstring("Returns INVOKEKIND.")]
  316.       INVOKEKIND InvocationKind();
  317.       
  318.       [propget, helpstring("Returns FUNCDESC.cParamsOpt, the number of optional parameters")]
  319.       short NumberOfOptionalParams();
  320.  
  321.       [propget, helpstring("Returns FUNCDESC.oVft, offset in vtbl")]
  322.       short OffsetInVtbl();
  323.  
  324.       [propget, helpstring("Returns FUNCDESC.wfuncFlags")]
  325.       unsigned short FuncFlags();
  326.  
  327.       [propget, helpstring("Returns kind of object (function == 0).")]
  328.       OBJTYPE Kind();
  329.       
  330.     }
  331.     
  332.     [
  333.       uuid(19FEEECA-4104-101B-B826-00DD01103DE1),          // IID_IProperty                
  334.       helpstring("Property object."),
  335.       odl
  336.     ]
  337.     interface IProperty : CMyDispatch                         
  338.     {
  339.       [propget, helpstring("Returns name.")]
  340.       BSTR Name();   
  341.       
  342.       [propget, helpstring("Returns the documentation string.")]
  343.       BSTR Documentation(void);
  344.         
  345.       [propget, helpstring("Returns the help context.")]
  346.       long HelpContext(void);
  347.         
  348.       [propget, helpstring("Returns the help file.")]
  349.       BSTR HelpFile(void);
  350.  
  351.       [propget, helpstring("Returns a ITypeDesc object that describes the type of property.")]
  352.       ITypeDesc* Type();
  353.       
  354.       [propget, helpstring("Returns memid.")]
  355.       MEMBERID Memberid();
  356.       
  357.       [propget, helpstring("Returns kind of object (property == 1).")]
  358.       OBJTYPE Kind();
  359.    
  360.     }  
  361.     
  362.     [
  363.       uuid(19FEEED4-4104-101B-B826-00DD01103DE1),          // IID_IConstant              
  364.       helpstring("Symbolic constant."),
  365.       odl
  366.     ]
  367.     interface IConstant : CMyDispatch                         
  368.     {
  369.       [propget, helpstring("Returns name.")]
  370.       BSTR Name();   
  371.       
  372.       [propget, helpstring("Returns the documentation string.")]
  373.       BSTR Documentation(void);
  374.         
  375.       [propget, helpstring("Returns the help context.")]
  376.       long HelpContext(void);
  377.         
  378.       [propget, helpstring("Returns the help file.")]
  379.       BSTR HelpFile(void);
  380.  
  381.       [propget, helpstring("Returns a ITypeDesc object that describes the type of constant.")]
  382.       ITypeDesc* Type();
  383.       
  384.       [propget, helpstring("Returns value of constant.")]
  385.       VARIANT Value();   
  386.       
  387.       [propget, helpstring("Returns memid.")]
  388.       MEMBERID Memberid();
  389.       
  390.       [propget, helpstring("Returns kind of object (constant == 2).")]
  391.       OBJTYPE Kind();   
  392.     }
  393.     
  394.     [
  395.       uuid(19FEEECB-4104-101B-B826-00DD01103DE1),          // IID_IParameter               
  396.       helpstring("Parameter object."),
  397.       odl
  398.     ]
  399.     interface IParameter: CMyDispatch                         
  400.     {
  401.       [propget, helpstring("Returns name of parameter.")]
  402.       BSTR Name();
  403.  
  404.       [propget, helpstring("Returns a ITypeDesc object that describes the type of parameter.")]
  405.       ITypeDesc* Type();    
  406.       
  407.       [propget, helpstring("Returns IDL flags of parameter.")]
  408.       int IDLFlags();
  409.       
  410.       [propget, helpstring("Returns kind of object (parameter == 3).")]
  411.       OBJTYPE Kind();    
  412.     }
  413.     
  414.     [
  415.       uuid(19FEEEC1-4104-101B-B826-00DD01103DE1),          // CLSID_TypeLibrary
  416.       helpstring("BrowseHelper Class"),
  417.       appobject
  418.     ]                                             
  419.     coclass BrowseHelper
  420.     {   
  421.       interface IBrowseHelper;
  422.     }
  423. }
  424.  
  425.