com::ptr Class

CLR クラスのメンバとして使用できる COM オブジェクトのラッパー。ラッパーはまた、デストラクタが呼び出されたときに所有するオブジェクトの参照をすべて解放し、COM オブジェクトの有効期間の管理を自動化します。これは、CComPtr クラス クラスと類似しています。

template<class _interface_type>
ref class ptr;

パラメータ

• _interface_type
  COM インターフェイス。

解説

com::ptr はまた、さまざまな COM タスクを簡素化すると共に、有効期間の管理を自動化するためのローカル関数変数として使用できます。

com::ptr は、関数パラメータとして直接使用することはできません。代わりに、% (Tracking Reference) または ^ (Handle to Object on Managed Heap) を使用します。

com::ptr は、関数から直接返すことはできません。代わりにハンドルを使用します。

使用例

この例では、プライベート メンバ IXMLDOMDocument オブジェクトをラップするために com::ptr を使用する CLR クラスを実装します。このクラスのパブリック メソッドを呼び出すと、含まれる IXMLDOMDocument オブジェクトが呼び出されます。このサンプルでは、XML ドキュメントのインスタンスを作成し、それに簡単な XML を格納したうえで、コンソールに XML を出力するために解析済みのドキュメント ツリーのノードを簡単に走査します。

// comptr.cpp
// compile with: /clr /link msxml2.lib
#include <msxml2.h>
#include <msclr\com\ptr.h>

#import <msxml3.dll> raw_interfaces_only

using namespace System;
using namespace System::Runtime::InteropServices;
using namespace msclr;

// a ref class that uses a com::ptr to contain an 
// IXMLDOMDocument object
ref class XmlDocument {
public:
   // construct the internal com::ptr with a null interface
   // and use CreateInstance to fill it
   XmlDocument(String^ progid) {
      m_ptrDoc.CreateInstance(progid);   
   }

   void LoadXml(String^ xml) {
      pin_ptr<const wchar_t> pinnedXml = PtrToStringChars(xml);
      BSTR bstr = NULL;

      try {
         // load some XML into the document
         bstr = ::SysAllocString(pinnedXml);
         if (NULL == bstr) {
            throw gcnew OutOfMemoryException;
         }
         VARIANT_BOOL bIsSuccessful = false;
         // use operator -> to call IXMODOMDocument member function
         Marshal::ThrowExceptionForHR(m_ptrDoc->loadXML(bstr, &bIsSuccessful));
      }
      finally {
         ::SysFreeString(bstr);
      }
   }

   // simplified function to write just the first xml node to the console
   void WriteXml() {
      IXMLDOMNode* pNode = NULL;

      try {
         // the first child of the document is the first real xml node
         Marshal::ThrowExceptionForHR(m_ptrDoc->get_firstChild(&pNode));
         if (NULL != pNode) {
            WriteNode(pNode);
         }
      }
      finally {
         if (NULL != pNode) {
            pNode->Release();
         }
      }
   }

   // note that the destructor will call the com::ptr destructor
   // and automatically release the reference to the COM object

private:
   // simplified function that only writes the node
   void WriteNode(IXMLDOMNode* pNode) {
      BSTR bstr = NULL;

      try {
         // write out the name and text properties
         Marshal::ThrowExceptionForHR(pNode->get_nodeName(&bstr));
         String^ strName = gcnew String(bstr);
         Console::Write("<{0}>", strName);
         ::SysFreeString(bstr);
         bstr = NULL;

         Marshal::ThrowExceptionForHR(pNode->get_text(&bstr));
         Console::Write(gcnew String(bstr));
         ::SysFreeString(bstr);
         bstr = NULL;

         Console::WriteLine("</{0}>", strName);
      }
      finally {
         ::SysFreeString(bstr);
      }
   }

   com::ptr<IXMLDOMDocument> m_ptrDoc;
};

// use the ref class to handle an XML DOM Document object
int main() {
   try {
      // create the class from a progid string
      XmlDocument doc("Msxml2.DOMDocument.3.0");

      // stream some xml into the document
      doc.LoadXml("<word>persnickety</word>");

      // write the document to the console
      doc.WriteXml();
   }
   catch (Exception^ e) {
      Console::WriteLine(e);   
   }
}

<word>persnickety</word>

必要条件

Header file <msclr\com\ptr.h>

Namespace msclr::com

参照

概念

C++ のサポート ライブラリ

ptr Members