Практическое руководство. Маршалинг строк BSTR для ADO.NET

Статья
11/05/2008

Обновлен: Ноябрь 2007

В данном руководстве демонстрируются способы добавления строк COM (BSTR) в базу данных и способы маршалирования System.String из базы данных в BSTR.

Пример

В данном примере класс DatabaseClass создается для взаимодействия с объектом ADO.NET DataTable. Обратите внимание, что этот класс должен представлять собой исходный класс C++ class (по сравнению с ref class или value class). Это необходимо, поскольку данный класс будет использоваться в машинном коде, в котором использование управляемых типов недопустимо. Этот класс компилируется для среды CLR в соответствии с директивой #pragma managed, предшествующей объявлению класса. Дополнительные сведения об этой директиве см. в разделе managed, unmanaged.

Обратите внимание на закрытый член класса DatabaseClass: gcroot<DataTable ^> table. Поскольку собственные типы не могут содержать управляемые типы, необходимо использовать ключевое слово gcroot. Дополнительные сведения о gcroot см. в разделеПрактическое руководство. Объявление дескрипторов в собственных типах.

Остальная часть кода в данном примере представляет собой машинный код языка C++ в соответствии с директивой #pragma unmanaged, предшествующей main. В данном примере создается новый экземпляр класса DatabaseClass, а также вызываются его методы для создания таблицы и добавления в нее нескольких строк. Обратите внимание, что строки COM передаются как значение в столбец базы данных StringCol. Внутри класса DatabaseClass эти строки маршалируются в управляемые строки с помощью механизма маршалинга пространства имен System.Runtime.InteropServices. В частности, используется метод PtrToStringBSTR для маршалирования BSTR в String и метод StringToBSTR — для маршалирования String в BSTR.

Примечание.
Память, выделенная методу StringToBSTR, должна освобождаться с помощью вызова FreeBSTR или SysFreeString.

// adonet_marshal_string_bstr.cpp
// compile with: /clr /FU System.dll /FU System.Data.dll /FU System.Xml.dll
#include <comdef.h>
#include <gcroot.h>
#include <iostream>
using namespace std;

#using <System.Data.dll>
using namespace System;
using namespace System::Data;
using namespace System::Runtime::InteropServices;

#define MAXCOLS 100

#pragma managed
class DatabaseClass
{
public:
    DatabaseClass() : table(nullptr) { }

    void AddRow(BSTR stringColValue)
    {
        // Add a row to the table.
        DataRow ^row = table->NewRow();
        row["StringCol"] = Marshal::PtrToStringBSTR(
            (IntPtr)stringColValue);
        table->Rows->Add(row);
    }

    void CreateAndPopulateTable()
    {
        // Create a simple DataTable.
        table = gcnew DataTable("SampleTable");

        // Add a column of type String to the table.
        DataColumn ^column1 = gcnew DataColumn("StringCol",
            Type::GetType("System.String"));
        table->Columns->Add(column1);
    }

    int GetValuesForColumn(BSTR dataColumn, BSTR *values,
        int valuesLength)
    {
        // Marshal the name of the column to a managed
        // String.
        String ^columnStr = Marshal::PtrToStringBSTR(
                (IntPtr)dataColumn);

        // Get all rows in the table.
        array<DataRow ^> ^rows = table->Select();
        int len = rows->Length;
        len = (len > valuesLength) ? valuesLength : len;
        for (int i = 0; i < len; i++)
        {
            // Marshal each column value from a managed string
            // to a BSTR.
            values[i] = (BSTR)Marshal::StringToBSTR(
                (String ^)rows[i][columnStr]).ToPointer();
        }

        return len;
    }

private:
    // Using gcroot, you can use a managed type in
    // a native class.
    gcroot<DataTable ^> table;
};

#pragma unmanaged
int main()
{
    // Create a table and add a few rows to it.
    DatabaseClass *db = new DatabaseClass();
    db->CreateAndPopulateTable();

    BSTR str1 = SysAllocString(L"This is string 1.");
    db->AddRow(str1);

    BSTR str2 = SysAllocString(L"This is string 2.");
    db->AddRow(str2);

    // Now retrieve the rows and display their contents.
    BSTR values[MAXCOLS];
    BSTR str3 = SysAllocString(L"StringCol");
    int len = db->GetValuesForColumn(
        str3, values, MAXCOLS);
    for (int i = 0; i < len; i++)
    {
        wcout << "StringCol: " << values[i] << endl;

        // Deallocate the memory allocated using
        // Marshal::StringToBSTR.
        SysFreeString(values[i]);
    }

    SysFreeString(str1);
    SysFreeString(str2);
    SysFreeString(str3);
    delete db;

    return 0;
}

StringCol: This is string 1.
StringCol: This is string 2.

Компиляция кода

Чтобы скомпилировать код из командной строки, сохраните пример кода в файл под названием adonet_marshal_string_native.cpp и введите нижеуказанный оператор:
```
cl /clr /FU System.dll /FU System.Data.dll /FU System.Xml.dll adonet_marshal_string_native.cpp
```