Приступая к работе с Microsoft Transaction Server

Microsoft® Transaction Server (MTS) является компонентно-ориентированной системой обработки транзакций для разработки и развертывания высокопроизводительных, масштабируемых и надежных приложений для серверов сетей Интернет и интранет организации, а также для управления ими. MTS определяет модель программирования для разработки распределенных компонентно-ориентированных приложений. Эта система предоставляет также инфраструктуру для выполнения приложений, графическое средство для развертывания приложений и для управления этими приложениями.

В данном разделе содержится обзор новых возможностей MTS, дается краткое описание документации и список используемых терминов. Раздел имеет следующие подразделы:

•	Новые возможности MTS

•	Документация по MTS

•	Список терминов MTS

•	Служебные программы MTS

•	Типичные вопросы по MTS


Новые возможности MTS

Microsoft Transaction Server (MTS) версии 2.0 содержит множество новых возможностей, облегчающих развертывание надежных и масштабируемых приложений для сетей Интернет и интранет. В данном разделе описываются новые возможности MTS.

Полная интеграция с Internet Information Server (IIS) версии 4.0

MTS 2.0 полностью интегрирован с IIS 4.0, предоставляя лучшую основу для разработки деловых приложений для Web. Новые возможности, связанные с интеграцией MTS и IIS, включают:

•	Активные серверные страницы (Active Server Pages), учитывающие транзакции

Сценарии активных серверных страниц могут теперь выполняться в управляемых с помощью MTS транзакциях. Это позволяет распространить преимущества защиты транзакций MTS на все Web-приложение.

•	Защита приложений IIS от сбоев

Web-приложения IIS могут теперь выполняться внутри своего собственного пакета MTS, обеспечивая изоляцию процессов и защиту Web-приложений от сбоев.

•	События, учитывающие транзакции

Разработчики имеют возможность встраивать команды в сценарии активных серверных страниц, позволяя настраивать отклик Web-приложений на основе исхода транзакций.

•	Контекст объектов для встроенных объектов IIS

Механизм контекста объектов MTS маскирует процесс сбора сведений о состоянии пользователей от разработчика приложения и позволяет отслеживать сведения, управляемые встроенными объектами IIS. Это расширяет простоту модели программирования MTS для разработчиков Web-приложений

•	Общие установка и управление

MTS и IIS имеют теперь общую установку и общую консоль управления, снижая сложность развертывания деловых приложений для Web и управления ими.

Поддержка протокола транзакций XA, включая встроенную поддержку для Oracle

•	MTS 2.0 поддерживает протокол транзакций XA, который позволяет приложениям MTS работать с базами данных IBM DB2, Informix и другими XA-совместимыми базами данных, работающими в системе Windows NT Server и в других операционных системах не от Microsoft (включая версии UNIX) с помощью средств ODBC.

•	Разработчики XA-совместимых баз данных проверяют свои драйверы ODBC на взаимодействие с MTS 2.0 по протоколу XA; обращайтесь за дополнительными сведениями к разработчику конкретной базы данных.

•	MTS 2.0 включает версию драйвера Microsoft ODBC для Oracle, позволяя приложениям MTS напрямую управлять транзакциями сервера Oracle версии 7.3 и выше с помощью средств ODBC.

Поддержка операционных систем для настольных компьютеров

0	MTS 2.0 может использоваться как с операционной системой Windows NT версии 4.0 или более поздней, так и с системой Windows 98. Поддержка MTS для настольных операционных систем Microsoft позволяет организациям развертывать автономные версии своих приложений MTS.

•	Система Windows 98 может использоваться в качестве системы для разработки компонентов MTS перед их развертыванием на сервере Windows NT. Компьютер с системой Windows 98 может быть также использован в качестве клиента администрирования для приложения-сервера MTS, работающего в системе Windows NT. Кроме того, MTS предоставляет среду времени выполнения для службы Personal Web Server (PWS), работающей в системе Windows 98.

•	Из-за различий между системами Windows NT и Windows 98, MTS для Windows 98 не поддерживает Microsoft Cluster Server или обеспечение безопасности MTS на основе ролей. Отсутствует возможность удаленного администрирования компьютера Windows 98 со службой MTS с компьютера Windows NT или Windows 98. Крме того, примеры Microsoft Visual Basic Scripting Edition (VBScript), демонстрирующие автоматизацию администрирования MTS, не устанавливаются вместе с MTS на компьютеры Windows 98.

Поддержка Microsoft Cluster Server

MTS 2.0 поддерживает Microsoft Cluster Server (MSCS), который позволяет автоматически исправлять сбои пакетов MTS в кластере. Это обеспечивает высокую устойчивость для приложений MTS.

Поддержка транзакций CICS и IMS через LU 6.2 Sync Level 2

MTS 2.0 позволяет организациям развертывать приложения MTS, поддерживающие транзакции CICS и IMS для MVS. MTS предлагает полную поддержку продукта COMTI (COM Transaction Integrator), компонента SNA Server, который обеспечивает взаимодействие MTS с CICS/MVS и IMS/MVS.

Усовершенствования администрирования

MTS 2.0 улучшает управление, облегчая развертывание и администрирование пакетов MTS, включая:

•	MTS Explorer как объект Snap-in

MTS Explorer является теперь объектом snap-in консоли Microsoft Management Console (MMC). Имеется возможность управлять пакетами MTS в одной консоли с другими продуктами, например с IIS. Дополнительные сведения о консоли MMC и использовании объектов snap-in содержатся в документации по MMC.

•	Завершение работы отдельных серверных процессов

В MTS 2.0 имеется возможность завершить работу отдельного пакета в MTS Explorer без завершения серверного процесса MTS. Завершение работы пакета приводит к остановке серверного процесса данного приложения. Следует отметить, что работа пакетов, администрируемых с помощью удаленного доступа на компьютере MTS 1.x, не может быть завершена по отдельности.

•	Усовершенствование параметров активизации для пакетов

В MTS 2.0 активизация задается только на уровне пакета. MTS больше не позволяет выполнять смешанную активизацию для компонентов пакета. Кроме того, невозможно запустить пакет с параметрами удаленной активизации. Для пакетов задается активизация типа Server (локальная активизация компонентов) или Library (активизация компонентов из вызывающего клиентского процесса).

Пакеты MTS 1.0, содержащие компоненты, помеченные внутренними (in-process), при установке MTS 2.0 будут автоматически обновлены на пакеты типа Library. Пакеты MTS 1.0, содержащие компоненты, помеченные локальными, при установке MTS 2.0 будут автоматически обновлены на пакеты типа Server. Пакеты MTS 1.0 со смешанной активизацией компонентов должны быть вручную настроены как пакеты типа Library или Server.

•	Возможность выбора нескольких объектов при обновлении свойств

Имеется возможность одновременно выбрать и изменить свойства нескольких объектов в MTS Explorer.

•	Перемещение компонентов между пакетами

Компоненты могут перемещаться между пакетами с помощью мыши.

Усовершенствование программирования

MTS 2.0 упрощают построение приложений MTS с помощью средств программирования, включая:

•	Новые и обновленные примеры приложений MTS.

Вместе с о обновленным приложением «Sample Bank» MTS теперь предоставляет два новых учетных приложения. Приложение «Tic-Tac-Toe» демонстрирует не поддерживающие транзакции компоненты, управляющие общим состоянием в простой многопользовательской игре. Примеры сценариев «Windows Scripting Host» для администрирования показывают, как использовать в сценариях объекты администрирования для автоматизации процедур в проводнике Windows.

•	Объекты администрирования для сценариев

Развертывание и обслуживание пакетов в среде MTS Explorer может быть автоматизировано с помощью объектов администрирования сценариев. Используя любой совместимый язык имеется возможность автоматизировать процедуры администрирования, такие как установка пакеты, с помощью простого сценария.

•	Документация по разработке и применению приложений MTS

Руководство программиста MTS содержит сведения по разработке и применению приложений MTS. Оно включает разделы от применения бизнес-логики в компонентах до вопросов диагностики и отладки.

См. также

Руководство администратора MTS, Обзор и понятия MTS


Документация по MTS

Microsoft Transaction Server (MTS) содержит документацию по разработке, сборке и развертыванию приложений MTS, а также по управлению ими.

Книга	Описание
Установка MTS	Описывается установка MTS и его компонентов, включая инструкции для доступа к базам данных Oracle из приложений MTS и установку учебных приложений MTS.
Приступая к работе с MTS	Обзор новых возможностей MTS, краткое описание документации и список используемых терминов.
Краткое руководство по MTS	Обзор MTS.
Руководство администратора MTS
Руководство администратора MTS	Описывает различные способы использования MTS Explorer для развертывания и администрирования приложений, а также содержит обзор графического интерфейса MTS Explorer.
Создание пакетов MTS	Содержит нацеленную на решения задач документацию по созданию и сборке пакетов MTS.
Распространение пакетов MTS	Содержит нацеленную на решения задач документацию по распространению пакетов MTS.
Установка пакетов MTS	Содержит нацеленную на решения задач документацию по установке и настройке пакетов MTS.
Обновление пакетов MTS	Содержит нацеленную на решения задач документацию по обновлению и наблюдению пакетов MTS.
Управление транзакциями MTS	Описывает распределенные транзакции и управление транзакциями с помощью MTS Explorer.
Автоматизация администрирования MTS	Дает обзор основных понятий, процедур и примеры программ, объясняющих использование объектов сценариев MTS для автоматизации процедур в среде MTS Explorer.
Руководство программиста MTS
Обзор и основные понятия	Содержит обзор продукта и совместной работы его компонентов, объясняет адреса MTS, необходимые разработчикам и администраторам систем клиент/сервер, а также дает углубленное описание понятий программирования для компонентов MTS.
Построение приложений для MTS	Содержит нацеленные на решение задач сведения по разработке компонентов ActiveX для MTS.
Справочник администратора MTS	Содержит справочные сведения по использованию объектов сценариев MTS для автоматизации процедур в среде MTS Explorer.
Справочник по MTS	Содержит справочные сведения по программному интерфейсу приложений (API) для MTS.
Справочник администратора MTS	Содержит справочные сведения по использованию объектов сценариев MTS для автоматизации процедур в среде MTS Explorer.


Служебные программы MTS

MTS предоставляет служебные программы для выполнения с командной строки, предназначенные для автоматизации определенных задач в пакетных файлах.

Служебные программы для командной строки

Краткое описание служебных программ для командной строки, устанавливаемых вместе с MTS, дается в приведенной ниже таблице.

Программа	Функции
MTXSTOP.exe	Завершение работы всех процессов MTS. Это версия для командной строки команды Завершить серверные процессы контекстного меню значка Мой компьютер.
MTXTEST.exe	Тестовый компонент, выполняющий формирование параметров программы для отправки за пределы среды выполнения MTS.
MTXTSTOP.exe	Остановка MTXTEST.exe. Это средство устанавливается только в случае выбора параметров установки для разработчика.
MTXREREG.exe	Обновление всех компонентов, зарегистрированных на компьютере. Это версия для командной строки команды Обновить компоненты из контекстного меню выбранного пакета.
MTXREPL.exe	Реплицировать сервер MTS. Должны быть запущены главный и подчиненный компьютеры.
TestOracleXAConfig.Exe	Тестирование конфигурации Oracle для проверки распределенных транзакций включающих компоненты MTS. При сбое данного программы, распределенные транзакции с базами данных Oracle работать не будут.
Средства администрирования Windows NT

Windows NT также предоставляет несколько средств, предназначенных для администрирования приложений MTS. Для применения этих средств нажмите кнопку Пуск, выберите пункт Программы, а затем выберите пункт меню Администрирование (Общее).

Средство		Функции
	окно просмотра событий	В Windows NT событие представляет любое важное происшествие в системе или в программе, которое должно быть отмечено для пользователя. Окно просмотра событий сообщает о событии пользователю или помещает его в журнал. Откройте окно просмотра событий в качестве первого этапа диагностики неполадки приложения MTS.
	Системный монитор	Системный монитор представляет собой средство наблюдения за быстродействием компьютера или других компьютеров в сети.
	Диспетчер серверов (Server Manager)	Диспетчер сервера отображает список рабочих станций и серверов вашего домена.
	Диспетчер пользователей для доменов (User Manager for Domains)	Диспетчер пользователей для доменов позволяет устанавливать, удалять или отключать учетные записи пользователей в домене. Он позволяет также задавать политику безопасности и добавлять учетные записи пользователей в группы.
	Диагностика Windows NT (Windows NT Diagnostics)	Программа диагностики Windows NT отображает сведения о ресурсах компьютера.
Внимание!   Для применения большинства из этих средств администрирования Windows NT требуется войти в систему в качестве администратора.

См. также

Руководство администратора MTS


Типичные вопросы по MTS

Ответы на типичные вопросы по Microsoft Transaction Server можно найти по адресу http://www.microsoft.com/support/.


Краткое руководство по Microsoft Transaction Server

Microsoft Transaction Server (MTS) является компонентно-ориентированной системой обработки транзакций для разработки и развертывания высокопроизводительных, масштабируемых и надежных приложений для серверов сетей Интернет и интранет организации, а также для управления ими.

Возможности Microsoft Transaction Server описываются в приведенных ниже разделах:

•	Что такое Microsoft Transaction Server

•	Среда выполнения Microsoft Transaction Server

•	Microsoft Transaction Server Explorer

•	Интерфейсы программирования приложений (API) Microsoft Transaction Server

•	Учебные приложения Microsoft Transaction Server


Что такое Microsoft Transaction Server

MTS является компонентно-ориентированной системой обработки транзакций для разработки и развертывания надежных приложений для сетей Интернет и интранет, а также для управления ими. Кроме того, MTS позволяет развертывать и администрировать приложения для сервера MTS с помощью мощного графического инструмента (MTS Explorer).

Возможности MTS:

	Среда выполнения MTS.
	MTS Explorer, графический интерфейс пользователя для развертывания и управления компонентов приложений.
	Интерфейсы программирования приложений и распределители  ресурсов для создания масштабируемых и надежных приложений. Распределители ресурсов представляют собой средства управления временным общим состоянием от имени компонентов приложения внутри процесса.
	Три учебных приложения, демонстрирующих использование интерфейса программирования приложений (API) для построения компонентов MTS и применение объектов администрирования сценариев для автоматизации процедур развертывания в MTS Explorer.
Модель программирования MTS предоставляет исходную базу разработки компонентов и заключает в себе бизнес-логику. Среда выполнения MTS является платформой промежуточного уровня для запуска этих компонентов. Имеется возможность использовать MTS Explorer для регистрации и управления выполнением компонентов в среде выполнения MTS.

Трехуровневая модель программирования предоставляет возможность разработчикам и администраторам работать в пределах двухуровневых клиент/серверных приложений. Развертывание и управление трехуровневыми приложениями позволяет проявлять большую гибкость по приведенным ниже причинам.

•	Трехуровневая модель вместо физической архитектуры выделяет логическую архитектуру приложений. Любая служба может вызывать любую другую службу и может размещаться в любом месте.

•	Эти приложения являются распределенными, то есть имеется возможность запускать нужные компоненты в нужным местах, позволяя пользователям оптимизировать использование компьютерных и сетевых ресурсов.

См. также

Документация по MTS


Среда выполнения Microsoft Transaction Server

Инфраструктура выполнения MTS облегчает разработку и развертывание приложений, а также управление ими, предоставляя разработчику и системному администратору полный и вместе с тем простой набор системных служб, которые включают:

•	Распределенные транзакции. Транзакцией называют совокупность действий, которые выполняются в рамках единой операции, которая либо успешно выполняется в целом, либо не выполняется.

•	Автоматическое управления процессами и потоками.

•	Управление экземпляром объекта.

•	Распределенная служба обеспечения безопасности для управления созданием и использованием объектов.

•	Графический интерфейс для системного администрирования и управления компонентами.

Разработчики приложений, использующие эти системные службы, при создания масштабируемых и надежных приложений могут сфокусироваться на решении своих деловых задач, а не на разработке системной инфраструктуры для них.

MTS работает с любыми средствами разработки приложений, способными создавать библиотеки динамической компоновки ActiveX. К примеру, разработчики могут воспользоваться Microsoft Visual Basic, Microsoft Visual C++, Microsoft Visual J++ или любым другим средством ActiveX для разработки приложений MTS.

MTS предназначен для работы с широким набором диспетчеров ресурсов, включая реляционные системы баз данных, файловые системы и системы хранения документов. Это позволяет разработчикам и независимым поставщикам программного обеспечения выбирать из широкого диапазона диспетчеров ресурсов, а также легко использовать два или более диспетчеров ресурсов в одном приложении для получения преимуществ от применения локальных и распределенных транзакций.

См. также

Обзор и основные понятия MTS


Microsoft Transaction Server Explorer

MTS Explorer представляет собой графический интерфейс пользователя для развертывания компонентов MTS и управления ими. Системные и Web-администраторы, а также разработчики могут использовать MTS Explorer для управления, распространения, развертывания и проверки пакетов. Разработчики используют MTS Explorer для сборки компонентов в готовые пакеты, а также для распространения и проверки компонентов в среде MTS. Кроме того, администраторы и разработчики используют Explorer для развертывания и обслуживания компонентов и пакетов. Кроме того, Explorer позволяет отслеживать транзакции для соответствующих компонентов и управлять ими.

Иерархические структуры Explorer описывают организацию следующих элементов в среде выполнения:

•	компьютеров;

•	пакетов;

•	компонентов

•	ролей;

•	интерфейсов;

•	методов.

Пакеты MTS установлены на компьютерах, которые содержат компоненты и определяют роли. Компоненты в пакете определяют интерфейсы и методы. Имеется возможность использовать окна специального назначения для просмотра транзакций и сведений из сообщений трассировки.

На следующем рисунке показан вид иерархической структуры в левой области Explorer:

Для просмотра свойств компонентов пакета (см. следующий рисунок) или установленных на компьютере пакетов используется окно свойств.

Для просмотра обзорных статистических сведений о последних транзакциях применяется окно Статистика транзакций.

Применение MTS Explorer

В левой области окна MTS Explorer отображается иерархическая структура объектов, а в правой области окна отображается содержимое выбранного в левой области объекта. Иерархия имеет древовидную структуру, которая содержит папки и все объекты, которые могут быть настроены с помощью MTS Explorer.

Для перемещения по иерархии объектов в MTS Explorer дважды щелкните папку или объект в правой области, чтобы отобразить содержимое соответствующего объекта. Чтобы просмотреть содержимое всех компонентов в правой области, щелкните соответствующую папку или объект в левой области. Чтобы развернуть любой элемент структуры, щелкните значок плюс (+) напротив него; структура соответствующего элемента будет отображена в левой области MTS Explorer. Двойным щелчком папки или объекта в левой области можно также раскрыть его содержимое в правой области, таким образом, имеется возможность переключаться между раскрытым и свернутым представлением объектов иерархии.

Для выбора объекта в любой области можно пользоваться клавишами со стрелками. Чтобы отобразить содержимое объекта, нажмите клавишу ввода (ENTER). Переход от одной области окна Explorer к другой можно осуществлять с помощью клавиши табуляции (TAB).

Следует отметить, что в Windows 98 дерево объектов в левой области MTS Explorer не отображается. Чтобы осуществлять перемещения: для перехода вниз по иерархии дважды щелкните значок, а для возврата вверх по иерархии щелкните кнопку панели инструментов На один уровень вверх. Дополнительные сведения об использовании MTS Explorer под Windows 98 содержатся в Руководстве администратора MTS.

Задание и просмотр свойств объекта

Основные сведения об объекте, добавленном в иерархию MTS Explorer, отображаются в окне свойств объекта. Эти сведения зависят от объекта. Например окно свойств для компьютера содержит имя компьютера, размещение файла журнала и параметры обновления, тогда как окно свойств для пакета содержит сведения о его безопасности и другие специальные параметры процессов.

Для просмотра окна свойств выберите объект, а затем выполните команду Свойства из меню Команда или из контекстного меню, открываемого правой кнопкой мыши. Каждое окно свойств имеет страницы, доступные с помощью выбора соответствующих вкладок.

Наблюдение за транзакциями

Расширенная поддержка обработки транзакций является основной характеристикой среды выполнения MTS. Microsoft Distributed Transaction Coordinator (MS DTC) обеспечивает поддержку обработки транзакций в MTS. MS DTC представляет службу Windows NT, которую MTS использует для обеспечения согласованности всех частей транзакции перед ее завершением.

Поддержка транзакций обеспечивается в иерархии MTS Explorer с помощью трех окон:

	Окно «Список транзакций» для наблюдения за состоянием активных транзакций.
	Для просмотра обзорных статистических сведений о последних транзакциях применяется окно «Статистика транзакций».
	Окно «Сообщения трассировки» применяется для просмотра сообщений трассировки, связанных с обработкой транзакции.
См. также

Руководство администратора MTS


Интерфейсы программирования приложений (API) Microsoft Transaction Server

Для разработки масштабируемых и надежных приложений, использующих преимущества среды выполнения MTS, а также для автоматизации администрирования пакетов и компонентов воспользуйтесь интерфейсами программирования приложений MTS (API).

Разработка клиентских приложений

Клиентские приложения, работающие вне среды выполнения MTS, создают объекты MTS с помощью стандартных функций библиотеки COM (CoCreateInstance в C++; метод CreateObject Visual Basic выполняет те же функции).

Разработка компонентов

При разработке компонентов MTS (серверных компонентов, которые будут зарегистрированы в среде выполнения MTS) можно использовать интерфейсы MTS IObjectContext, ISharedPropertyGroupManager, ISharedPropertyGroup и ISharedProperty для:

•	описания того, что работа объекта закончена;

•	предотвращения завершения транзакции;

•	создания других объектов;

•	включения работы других объектов в область определения транзакции текущего объекта;

•	определения того, что вызывающий клиент имеет определенную роль;

•	определения того, что система обеспечения безопасности включена.

Автоматизация администрирования MTS

Имеется возможность автоматизировать администрирование пакетов и компонентов с помощью объектов администрирования MTS. С помощью языков Visual Basic, Visual Basic Scripting Edition (VBScript) или любого другого языка, поддерживающего программирование объектов, можно автоматизировать процедуры MTS Explorer от установки готового пакета до перечисления связанных семейств объектов.

См. также

Руководство администратора MTS, Обзор и понятия MTS,Справочник по MTS, Справочник администратора MTS


Учебные приложения Microsoft Transaction Server

В дополнение к документации MTS включает учебные приложения, являющиеся незаменимыми средствами обучения. Любую часть этих приложений можно скопировать в свое собственное приложение и изменить нужным образом.

В руководстве программиста MTS примеры учебных программ и приложений иллюстрируют методы программирования MTS. Многие файлы приложений устанавливаются по умолчанию. Исходные файлы приложений находятся в папке \Samples установочного диска MTS.

В MTS входят следующие учебные приложения.

Пример	Описание
Sample Bank	Простая база данных с поддержкой транзакций, которая демонстрирует использование интерфейсов программирования приложений MTS.
Tic-Tac-Toe	Простая многопользовательская игра, показывающая как компоненты без поддержки транзакций управляют общим состоянием.
Примеры административных сценариев	Сценарии объектов администрирования демонстрируют автоматизацию процедур MTS Explorer с помощью языка VBScript.
См. также

Установка примеров и документации для разработчика MTS, Установка учебного банковского приложения MTS, Установка учебного приложения MTS «Tic-Tac-Toe», Установка учебных административных сценариев MTS, Обзор и понятия MTS, Пример сценария Visual Basic для автоматизации администрирования MTS


Установка Microsoft Transaction Server

Microsoft Transaction Server (MTS) представляет собой мощную среду, позволяющую упростить разработку и развертывание высокопроизводительных, масштабируемых и надежных приложений масштаба предприятия для сетей Интернет и интрасетей. MTS определяет модель программирования для разработки распределенных компонентно-ориентированных приложений. Эта система предоставляет также инфраструктуру для выполнения приложений, графическое средство для их развертывания и средство для управления этими приложениями.

Сведения по установке и настройке MTS содержатся в следующих разделах:

•	Системные требования MTS

•	Установка примеров и документации для разработчика MTS

•	Настройка сервера MTS

•	Настройка MTS с Microsoft Cluster Server

•	Настройка MTS для доступа к Oracle

•	Установка учебного приложения MTS «Sample Bank»

•	Установка учебного приложения MTS «Tic-Tac-Toe»

•	Установка учебных административных сценариев MTS

•	Получение справки при работе с MTS


Системные требования MTS

В данном разделе описываются требования к аппаратному и программному обеспечению, необходимому для установки MTS, обсуждаются другие вопросы установки и описывается поддержка MTS в системах с процессором Alpha.

Чтобы установить MTS на компьютер:

•	воспользуйтесь пакетом Windows NT 4.0 Option Pack для установки MTS вместе в Internet Information Server (IIS) или другими компонентами Option Pack;

•	воспользуйтесь пакетом Windows NT4.0 Option Pack для установки только MTS без других компонентов Option Pack.

MTS выполняется в системах Windows NT, Windows 98 и Windows 95 с поддержкой модели DCOM.

Важно! Если уже используется IIS 2.0 или IIS 3.0, не устанавливайте MTS без установки IIS 4.0 в Windows NT Option Pack.

Чтобы установить MTS без других компонентов пакета Option Pack:

1	Запустите программу установки (Setup) пакета Option Pack. Нажмите кнопку Выборочной установки.

2	Снимите флажки всех компонентов Option Pack.

3	Выберите, но не устанавливайте флажок для Transaction Server.

4	Нажмите кнопку Состав.

5	Установите флажок Компоненты ядра Transaction Server. При этом устанавливается также флажок Microsoft Management Console.

При выборе компонентов, предназначенных для разработчиков, устанавливаются также компоненты доступа к данных.

6	Нажмите кнопку OK и продолжите выполнение программы установки.

Требования к аппаратному обеспечению

Перед установкой Microsoft Transaction Server убедитесь, что оборудование компьютера удовлетворяет перечисленным ниже минимальным требованиям.

•	Компьютере с процессором i386 и системой Windows NT, Windows 98 или Windows 95 с поддержкой модели DCOM, либо компьютер с процессором Alpha AXP™. См. файл Readme для получения новейших данных о требованиях к оборудованию.

•	Жесткий диск, имеющий не менее 30 Мбайт свободного места для полной установки.

•	Дисковод для компакт-дисков.

•	Любой монитор, поддерживаемый системой Windows NT версии 4.0 или более поздней, либо Windows 98.

•	Не менее 32 Мбайт памяти.

•	Мыши или другое совместимое указательное устройство.

Имеется возможность запустить установку MTS в автономном режиме с помощью программы установки пакета Windows NT 4.0 Option Pack. Перед таким запуском измените в файле программы установки необходимые параметры. Файл для автономной установки (unattend.txt) находится в каталоге \MTS.

Чтобы запустить установку в автономном режиме, нажмите кнопку Пуск, выберите пункт Выполнить и введите строку:

setup /u:unattend.txt.

Требования к программному обеспечению

Требования MTS к программному обеспечению включают перечисленное ниже.

•	Перед установкой MTS необходимо установить на компьютер систему Microsoft Windows NT версии 4.0 или более поздней, Windows 98, либо систему Windows 95 с поддержкой модели DCOM. Если поддержка модели DCOM для Windows 95 не будет установлена перед установкой MTS, это приведет к появлению следующего сообщения об ошибке:

Не удается загрузить библиотеку mtssetup.dll или найти функцию MTSSetupProc.

Поддержку модели DCOM для Windows 95 можно установить с узла Интернета http://www.microsoft.com/oledev. Поддержка DCOM для Windows 95 устанавливается при установке программы Internet Explorer 4.0. Windows 98 включает поддержку модели DCOM.

При удалении MTS на компьютере с системой Windows 95 не удаляйте поддержку модели DCOM для Windows 95. Программе Microsoft Distributed Transaction Coordinator (MS DTC), устанавливаемой, но не удаляемой программой установки MTS, требуется поддержка модели DCOM для Windows 95.

•	Если необходимо использовать удаленное администрирование компьютера Windows NT с компьютера Windows 98, необходимо установить службу Remote Registry для Windows 98. Служба Remote Registry позволяет изменять записи реестра для удаленного компьютера Windows NT (если предоставить ей нужные разрешения). Чтобы найти службу Remote Registry, перейдите в каталог \Admin\Nettols\RemoteReg на компакт-диске Windows 98. Инструкции по установке службы содержатся в файле Regserv.txt.

•	Для использования клиента Microsoft Windows 95 с MTS установите поддержку модели DCOM для Windows 95. Дополнительные сведения по поддержке модели DCOM для Windows 95 содержатся на узле http://www.microsoft.com/oledev/. Следует отметить, что система Windows 98 включает поддержку DCOM.

•	При использовании Windows NT Server необходимо установить пакет Windows NT Service Pack 3. Имеется возможность загрузить пакет Windows NT Service Pack 3 с узла http://www.microsoft.com/support.

•	Если требуется доступ компонентов к базам данных, воспользуйтесь Microsoft SQL Server версии 6.5 или более поздней, либо другой совместимой с Microsoft Transaction Server базой данных. Для SQL Server требуется операционная система Windows NT.

•	Настоятельно рекомендуется установить пакет SQL Server Service Pack 4 на компьютеры с программным обеспечением MTS. Этот пакет устраняет несколько известных неполадок. Пакет SQL Server Service Pack 3 можно установить с узла http://www.microsoft.com/support/.

•	Если планируется создавать компоненты с помощью Microsoft Visual Basic, воспользуйтесь Microsoft Visual Basic, Enterprise Edition версии 4.0 или более поздней. Настоятельно рекомендуется для сборки компонентов MTS использовать Visual Basic версии 5.0 или более поздней.

Если для построения библиотеки DLL используется Visual Basic, установите надстройку VB (addin), предлагаемую в качестве компонента выборочной установки Transaction Server. Использование этой настройки правильно обновляет каталог MTS, даже после того как Visual Basic создает коды GUID новых компонентов в процессе компиляции. Дополнительные сведения содержатся в разделе Требования компонентов MTS.

•	Если планируется создание компонентов с помощью Microsoft Visual C++®, воспользуйтесь версией 4.1 или более поздней с библиотекой шаблонов Active Template Libraries (ATL) версии 1.1 или более поздней. При использовании Visual C++ версии 4.1 необходимо иметь Win32 SDK.

•	Если планируется создавать и запускать с MTS компоненты Java, воспользуйтесь виртуальной машиной Microsoft Java, устанавливаемой с программой IE 4.0 или более поздней версии. Имеется возможность загрузить Internet Explorer с узла http://www.microsoft.com/ie/.

•	Если планируется создавать приложения Интернета, необходимо использовать Microsoft Internet Information Server версии 4.0 или более поздней и Microsoft Internet Explorer версии 4.0 или более поздней.

•	Для применения MTS с базой данных Oracle см. раздел Настройка MTS для доступа к Oracle, содержащий важные сведения по организации совместной работы Oracle и Microsoft Transaction Server.

Невозможно удаленное администрирование компьютеров MTS 2.0 с компьютеров MTS 1.x

Невозможно удаленное администрирование установки MTS 2.0 с компьютера, на котором выполняется предыдущая версия MTS. При попытке выполнить такое администрирование приведет к возврату ошибочного кода или к непредвиденной остановке MTS Explorer.

Использование клиента Advanced Data Connector 1.1

Клиент ADC 1.5 работает только с Internet Explorer (IE) 4.0. Клиент ADC 1.5 не будет работать ни с какой программой Internet Explorer более ранней версии, чем IE 4.0.

Пользователи учебного приложения MTS Adventure Works могут найти обновленную версию клиента ADC 1.1, который работает с Internet Explorer версии 3.0 или более поздней, на узле http://www.microsoft.com/adc. Для задания ссылки на новую библиотеку наборов записей ADC 1.5 (Msador15.dll) потребуется перекомпилировать пример MTS Adventure Works.

Завершение работы Visual Basic 5.0 с MTS 2.0

После установки MTS 2.0 возможен вывод сообщения о нарушении прав доступа при завершении работы Microsoft Visual Basic 5.0. Это известная ошибка Visual Basic 5.0, которую можно исправить с помощью установки пакета Visual Studio Service Pack 2 с узла http://www.microsoft.com/vstudio. Дополнительные сведения по этому вопросу содержатся в статье Q167213 базы данных Knowledge Base.

Взаимоблокировка в Windows 98 при использовании именованных каналов

Известно, что возможно возникновение взаимоблокировки при использовании примерно более 40 подключений именованных каналов от клиента Windows 98 к MS SQL Server. Чтобы устранить неполадку, замените протокол между драйвером ODBC и сервером SQL Server на протокол TCP/IP.

Запуск сценария INSTCAT.SQL

Для удобства MTS включает сценарий INSTCAT.SQL. Этот сценарий обновляет сохраненные процедуры каталога для драйвера SQL Server ODBC. Если это еще не было выполнено, запустите этот сценарий с помощью служебной программы SQL Server isql. Этот сценарий устраняет все потенциальные неполадки, связанные с несоответствием версий, которые могут возникать с каталогами SQL Server.

Установка SQL Server с MTS

Имеется возможность установить SQL Server 6.5 после установки MTS. Рекомендуется установить SQL Server 6.5 перед установкой MTS. Если установить SQL Server 6.5 после установки MTS, программа установки MTS будет пытаться убедиться, что служба MS DTC работает правильно.

Установка MTS 1.0 после MTS 2.0

Чтобы установить MTS 1.0 на компьютер с установленной версией MTS 2.0, необходимо удалить следующие файлы из системного каталога перед запуском установки MTS 1.0:

%WINDIR%\system32\adme.dll

%WINDIR%\system32\dac.exe

%WINDIR%\system32\dacdll.dll

%WINDIR%\system32\dtccm.dll

%WINDIR%\system32\dtctrace.dll

%WINDIR%\system32\dtctrace.exe

%WINDIR%\system32\dtcuic.dll

%WINDIR%\system32\dtcuis.dll

%WINDIR%\system32\dtcutil.dll

%WINDIR%\system32\dtcxatm.dll

%WINDIR%\system32\enudtc.dll

%WINDIR%\system32\logmgr.dll

%WINDIR%\system32\msdtc.exe

%WINDIR%\system32\msdtc.dll

%WINDIR%\system32\msdtcprx.dll

%WINDIR%\system32\msdtctm.dll

%WINDIR%\system32\dtccfg.cpl

%WINDIR%\system32\svcsrvl.dll

%WINDIR%\system32\xolehlp.dll

%WINDIR%\system32\mmc.exe

%WINDIR%\system32\mmc.ini

%WINDIR%\system32\mmclv.dll

%WINDIR%\system32\mmcndmgr.dll

%WINDIR%\system32\mtxinfr1.dll

%WINDIR%\system32\mtxinfr2.dll

%WINDIR%\system32\mtxclu.dll

%WINDIR%\system32\mtxrn.dll

%WINDIR%\system32\mtxdm.dll

Параметр удаления установки приводит к удалению определяемых пользователем пакетов

Если используется предыдущая версия MTS, и нужно сохранить определяемые пользователем пакеты, не используйте параметр Удаление в программе установки или значок Установка или удаление программ на панели управления. Удаление установки MTS приводит к удалению всех определяемых пользователями пакетов. Чтобы сохранить такие пакеты при обновлении, установите MTS поверх существующей версии MTS.

Неправильные пароли для удостоверений системных пакетов

Если при установке неправильно указать пароль для удостоверения системного пакета, Microsoft Transaction Server Explorer не будет запущен. Будет получено сообщение об ошибке 80008005 (сбой исполняемого файла сервера) от сервера каталога (системного пакета). Чтобы исправить неверно заданный системный пароль, переустановите Microsoft Transaction Server.

Кроме того, если неправильно задать пароль для удостоверения системного пакета, не будет запущен пакет. Будет получено то же сообщение об ошибке 80008005. Но в данном случае клиенту будет предоставлен результат сбоя HRESULT для CoCreateInstance или эквивалентной функции. Чтобы исправить данную ситуацию, вернитесь в Explorer и настройте удостоверение пакета (на вкладке Удостоверение). Из-за ограничений системы безопасности в Windows NT проверяются только коды пользователей, но не пароли.

Системы на процессоре Alpha

MTS поддерживается на компьютерах с процессором Alpha AXP™. Однако данная версия Microsoft Transaction Server для систем на процессоре Alpha не включает перечисленные ниже возможности.

•	Компоненты и примеры Microsoft Visual J++

Примеры для компонентов Microsoft Visual C++ и Visual Basic, а также примеры административных сценариев могут быть найдены в папке \Program Files\Mts\Samples.

Последние сведения о поддержке систем на процессоре Alpha содержатся на узле http://www.microsoft.com/transaction.

Чтобы проверить установку MTS в системе с процессором Alpha, запустите приложение «Sample Bank» на двух компьютерах, с процессором Alpha (как сервер) и с процессором X86 (как клиент). См. дополнительные сведения в разделе Установка учебного приложения MTS «Sample Bank».


Установка примеров и документации для разработчика MTS

Для установки примеров и документации для разработчика Microsoft Transaction Server (MTS) задайте Выборочный режим установки. В следующем списке описаны компоненты MTS, устанавливаемые в разных режимах.

•	Сокращенная

Установка среды выполнения MTS и MTS Explorer.

•	Обычная

Установка среды выполнения MTS, MTS Explorer и документации по ядру MTS.

•	Выборочная

Установка среды выполнения MTS, MTS Explorer, документации по ядру MTS, примеров и документации для разработчика MTS.

Чтобы получить примеры и документацию для разработчика MTS, рекомендуется использовать Выборочный режим установки. Изучение этих примеров и документации дает более полное представление об управлении пакетами и компонентами. Например имеется возможность использовать учебные приложения MTS «Sample Bank» и «Tic-Tac-Toe» для получения опыта в развертывании пакетов и в управлении ими с помощью MTS Explorer. Учебные приложения помогают также убедиться, что MTS был установлен правильно.

В документации для разработчика MTS объясняются решения, которые определяют упаковку компонентов, например параметры активизации и свойства транзакций. Вместе с обсуждением концепций программирования MTS (например предоставления общего доступа) руководство программиста MTS содержит также учебник, описывающий установку и настройку приложения «Sample Bank».

Чтобы получить примеры и документацию разработчика MTS после проведения установки в сокращенном или обычном режиме:

1	Нажмите кнопку Пуск, выберите пункт Настройка, а затем —Панель управления.

2	Щелкните значок Установка и удаление программ, выберите Microsoft Transaction Server, а затем нажмите кнопку Добавить/Удалить.

Следует помнить, что при удалении установки MTS будут удалены все определяемые пользователем пакеты. Чтобы сохранить такие пакеты, установите MTS без удаления предыдущей установки.

3	В программе установки нажмите кнопку Переустановить.

4	Выберите параметр Microsoft Transaction Server, а затем нажмите кнопку Состав.

5	Проверьте, что установлены флажки всех дополнительных компонентов MTS.

6	Нажмите кнопку ОК.


Настройка сервера MTS

После установки MTS настройте сервер MTS так, чтобы иметь возможность развертывать пакеты MTS и управлять ими с помощью MTS Explorer. Прежде чем начать развертывание пакетов и управление ими, настройте исходный сервер MTS следующим образом:

•	настройте роли и удостоверения для пакета System;

•	настройте администрируемые компьютеры;

кроме того, убедитесь, что учетная запись пользователя для удостоверений пакета System и других пакетов MTS имеет права пользователя Windows NT «Log on as a service» (Вход в качестве службы).

 Чтобы проверить права пользователя Windows NT для учетной записи:

1	Выполните команду User Rights (Права пользователя) из меню Policies (Политика).

2	Установите флажок Show Advanced User Rights (Показать дополнительные права).

Настройка ролей для системного пакета

Для безопасного развертывания пакетов MTS и управления ими необходимо сопоставить роль администратора системного пакета с нужным пользователем. Когда MTS установлен системный пакет не должен иметь ни одного пользователя, сопоставленного с ролью администратора. Таким образом, безопасность системного пакета отключена, и любой пользователь может использовать MTS Explorer для изменения конфигурации пакета на данном компьютере. Если сопоставить пользователей с ролями системного пакета, MTS будет включать проверку при попытке пользователя изменить пакеты с помощью MTS Explorer.

По умолчанию системный пакет имеет роли администратора и читателя. Пользователи, сопоставленные с ролью администратора системного пакета, могут использовать любую функцию MTS Explorer. Пользователи, которые сопоставлены с ролью читателя, могут просматривать все объекты в структуре MTS Explorer, но не могут устанавливать, создавать, изменять или удалять объекты, а также завершать серверные процессы или экспортировать пакеты. Например, если сопоставить пользователя домена Windows NT с ролью администратора системного пакета, этот пользователь сможет добавлять, изменять или удалять пакет с помощью MTS Explorer.

Если MTS установлен на сервере, играющем роль основного или резервного контроллера домена, то, чтобы управлять пакетами в MTS Explorer, пользователь должен быть администратором домена.

Дополнительные сведения по сопоставлению пользователей и ролей содержатся в разделе Сопоставление ролей MTS с пользователями и группами.

Имеется также возможность настроить новые роли для системного пакета. Например, можно настроить роль разработчика, которая позволяет устанавливать и запускать пакеты, но не позволяет удалять или экспортировать их. Учетные записи пользователей или групп Windows NT, сопоставленные с данной ролью, смогут проверять установку пакетов на данный компьютер, не имея полного набора административных привилегий для этого компьютера. Дополнительные сведения по установке новых ролей содержатся в разделе Добавление новой роли MTS.

После настройки ролей для системного пакета компьютера включите проверку прав доступа, установив флажок на вкладке безопасности пакета в окне свойств. Полное описание того, как включить проверку прав доступа, содержится в разделе Включение безопасности пакета MTS.

Следует отметить, что следующие административные функции MS DTC не используют системный пакет или роль системного пакета:

•	окно «Статистика транзакций»

•	окно «Статистика транзакций»

•	окно «Сообщения трассировки»

•	команды запуска/остановки MS DTC

Настройка компьютеров на администрирование с помощью MTS Explorer

По умолчанию компьютер, на который устанавливается MTS, управляется с помощью MTS Explorer под именем «Мой компьютер». Имеется возможность использовать MTS Explorer для управления другими компьютерами. Добавьте новые компьютеры, которые нужно администрировать в папку «Компьютеры» в Explorer, выбирая значок «Компьютер» и выполняя одно из приведенных ниже действий:

•	Выполните команду Создать из меню Действие

•	Щелкните значок Создание нового объекта на панели инструментов MTS Explorer

•	Щелкните правой кнопки мыши значок «Мой компьютер» и выполните команду Создать, а затем — Компьютер.

Затем введите в диалоговое окно имя компьютера в домене Windows NT, чтобы добавить удаленный компьютер в качестве папки верхнего уровня.  Чтобы получить доступ и отобразить MTS Explorer на удаленном сервере, учетная запись для входа в систему должна быть сопоставлена с ролью Reader. Чтобы иметь полные привилегии на чтение и запись в MTS Explorer на удаленном сервере, учетная запись для входа в систему должна быть сопоставлена с ролью Administrator.

Дополнительные сведения по управлению объектами в структуре MTS Explorer содержатся в разделе Структура MTS Explorer.

Важно! Невозможно удаленное администрирование MTS на компьютере Windows 98 из MTS с сервера Windows NT.


Настройка MTS с Microsoft Cluster Server

Microsoft Cluster Server (MSCS) представляет собой кластерное решение для компьютеров с системой Windows NT Server. MSCS версии 1.0 поддерживает кластеры из двух, специальным образом связанных серверов с системой Windows NT Server. Если на одном из серверов в кластере происходит сбой, или он выключается, другой сервер перехватывает операции неисправного сервера.

Если необходимо использовать Microsoft Transaction Server вместе с MSCS, сначала установите Windows NT Server 4.0 Enterprise. Затем установите Microsoft Cluster Server 1.0. И наконец, установите Microsoft Transaction Server 2.0 как описано ниже.

Примечание.   Поддержка кластеров в MTS 2.0 не работает с предварительными версиями Microsoft Cluster Server 1.0. Установка MTS 2.0 с предварительной версией Microsoft Cluster Server не обеспечит нормальной работы MSCS.

Дополнительные сведения по MSCS содержатся в электронной документации Windows NT (Books Online).

 Чтобы установить Microsoft Transaction Server 2.0 вместе с Microsoft Cluster Server 1.0:

1	Установите Windows NT Server 4.0 Enterprise.

2	Установите MSCS 1.0 на все компьютеры в кластере.

3	Воспользуйтесь программой «MSCS Cluster Administrator» для настройки группы, содержащей «Network Name Resource» и «Shared Disk Resource».

4	Установите Microsoft Transaction Server 2.0 на узел, которому принадлежит настроенная выше группа. Дополнительные сведения содержатся в разделе Установка Microsoft Transaction Server.

5	Когда программа установки MTS определяет, чтоб в системе имеется MSCS, она отображает диалоговое окно с запросом имени виртуального сервера (Virtual Server), на котором должен быть установлен MS DTC (Microsoft Distributed Transaction Coordinator). Укажите имя Network Name Resource, настроенного на шаге 3.

6	В том же окне укажите размещение файла журнала MS DTC на общем диске, настроенном на шаге 3.

7	Для продолжения программы установки MTS нажмите кнопку Далее.

8	Установите MTS на второй компьютер в кластере. Во время установки будет выдан запрос размещения виртуального сервера и файла журнала.

Не запускайте программу установки MTS параллельно на узлах кластера. Полностью установите MTS на одном узле, затем установите MTS на втором узле без перезагрузки первого узла. После установки MTS на обоих узлах, перезагрузите их.

Примечание.  Не требуется удалять установку Microsoft Transaction Server 1.0 перед установкой Microsoft Transaction Server 2.0 с Microsoft Cluster Server 1.0. Следуйте инструкциям по установке MTS 2.0 с MCS 1.0.

 Чтобы обновить установку Microsoft Transaction Server версии 1.1 на версию Microsoft Transaction Server 2.0 с Microsoft Cluster Server:

1	Удалите все ресурсы пакетов Microsoft Transaction Server, которые были созданы с помощью Microsoft Transaction Server 1.1 с Microsoft Cluster Server.

2	Запустите программу установки Microsoft Transaction Server 2.0 на узле кластера, которому принадлежит ресурс MS DTC (Microsoft Distributed Transaction Coordinator). При этом будет автоматически выполнено обновление данного узла.  Убедитесь, что установка Microsoft Transaction Server полностью выполнена, прежде чем приступить к следующему шагу.

3	Запустите программу установки Microsoft Transaction Server 2.0 на втором узле кластера.

4	Перезагрузите оба узла.

Удаление установки Microsoft Cluster Server на MTS Server

Если требуется удалить установку Microsoft Cluster Server с одного из узлов кластера, выполните приведенные ниже процедуры.

1	Воспользуйтесь программой «Cluster Administrator», чтобы отключить ресурс MS DTC (Microsoft Distributed Transaction Coordinator).

2	Удалите установку Microsoft Cluster Server с узла и перезагрузите этот узел.

3	Измените размещение файла журнала MS DTC с помощью Transaction Server Explorer. Файл журнала нужно поместить на недоступный для других пользователей диск. Если это не удается сделать, файл журнала может быть поврежден, либо это вызовет ошибку нарушения доступа в MS DTC.

Сброс файла журнала MS DTC на кластерных серверах

Чтобы сбросить файл журнала MS DTC на кластерном сервере, необходимо запустить MTS Explorer на узле, которому в данное время принадлежит общий диск, содержащий файл журнала.

Запуск и остановка MS DTC на кластерных серверах

На кластерном сервере имеется возможность запустить и остановить MS DTC с помощью MTS Explorer или с помощью административной служебной программы MSCS. Команды "net start msdtc" или "net stop msdtc" не работают. Чтобы запустить и остановить MS DTC на кластере MSCS с командной строки, воспользуйтесь командами "msdtc -start" и "msdtc -stop", соответственно.

Вызов объектов MTS после сбоя MSCS

Приложение клиента Microsoft Transaction Server всегда должно освобождать все ссылки на компоненты MTS на сбойном узле и подключать эти компоненты. Эти компоненты продолжают работать на втором узле.

Использование папки удаленных компонентов с кластерными серверами

Имеется возможность использовать папку удаленных компонентов (Remote Components) для получения компонентов с узла Microsoft Cluster Server (MSCS) с помощью следующих шагов:

1	На компьютере сервера, с которого будут выбираться компоненты, щелкните правой кнопкой мыши значок «Мой компьютер» и выполните команду контекстного меню Свойства.

2	Выберите вкладку Параметры и введите имя виртуального сервера в поле Имя удаленного сервера. Нажмите кнопку ОК.

3	На компьютере клиента, на который будут загружаться компоненты, добавьте компьютер MSCS в папку Компьютеры, используя физическое имя сервера.

4	Выберите папку Удаленные компоненты и выполните команду Создать из меню Действие. Имеется также возможность щелкнуть правой кнопкой мыши папку «Удаленные компоненты» и выполнить команды контекстного меню Создать и Компонент.

5	Следуйте инструкциям мастера установки удаленных компонентов. Следует отметить, что во время установки удаленных компонентов будет отображаться физическое, а не виртуальное имя сервера (как указано в поле Имя удаленного сервера для компьютера сервера).

6	Выберите папку «Удаленные компоненты» и нажмите кнопку «Свойства» на панели инструментов MTS Explorer. Столбец «Сервер» в области таблицы отображает виртуальное имя сервера.

Примечание.   Если изменить имя удаленного сервера на компьютере MSCS, необходимо также переустановить удаленные компоненты на компьютерах клиентов.

Репликация пустых пакетов

При репликация MTS пустые пакеты не реплицируются.

Удостоверения пакета MTS должны быть в группе администраторов в кластерах MSCS

Для пакетов MTS в кластерах MSCS учетная запись пользователя, связанная с удостоверением пакета, должна соответствовать системному администратору или должна иметь разрешение на полный доступ к кластеру (как задается в cluadmin). Если пакет не запускается с удостоверением системного администратора, MTS не сможет подключиться к службе MS DTC.

Завершите работу ресурсов кластера MSCS перед установкой MTS

Необходимо завершить работу всех ресурсов кластера MSCS (например сервера SQL Server), на которые влияет установка MTS, перед запуском программы установки MTS.

Имя удаленного сервера должно указывать виртуальный сервер на серверах MSCS

Кластеризованные серверы должны задать с помощью MTS Explorer значение виртуального сервера для свойства Имя удаленного сервера. Это позволяет удаленным клиентам получать доступ к компонентам MTS внутри кластера, и, в случае сбоя, гарантировать, что клиенты ссылаются на кластер, а не на специфический узел внутри кластера.


Настройка MTS для доступа к Oracle

Компоненты Microsoft Transaction Server могут обращаться к:

•	базам данных Oracle 7 и Oracle 8;

•	базам данных Oracle как в системе Windows NT, так и в системе Unix;

•	серверам Oracle Workgroup Servers;

•	серверам Oracle Enterprise Servers;

•	серверам Oracle Parallel Servers.

В данном разделе описываются следующие вопросы:

Необходимое программное обеспечение

Установка поддержки Oracle

Проверка установки и настройки поддержки Oracle в MTS

Проверка установки и настройки поддержки Oracle с помощью приложения «Sample Bank»

Администрирование Oracle и Microsoft Distributed Transaction Coordinator

Известные ограничения поддержки Oracle в MTS

Необходимое программное обеспечение

Для доступа к базе данных Oracle из компонентов Microsoft Transaction Server необходимо следующее программное обеспечение.

Компонент	Версия
База данных Oracle под Windows NT	7.3.4 или Oracle 8
База данных Oracle под UNIX	(с обновлениями) или Oracle 8
Microsoft Transaction Server 2.0	2.0
Драйвер Microsoft Oracle ODBC	02.73.7283.1 или более поздняя
ActiveX Data Objects (ADO)	1.5 или более поздняя
Примечание. Предыдущие версии программного обеспечения не будут работать правильно. Убедитесь, что установлены данные или более поздние версии программного обеспечения. Большинство ошибок совместного использования MTS с Oracle связанно с применением старых версий программ.

База данных Oracle 7.3 для Windows NT

Компоненты транзакций Microsoft Transaction Server могут получить доступ к базе данных Oracle 7.3 под Windows NT. Можно использовать Oracle 7.3.4 Workgroup Server для Windows NT или Oracle 7.3.4 Enterprise Server для Windows NT. Более ранние выпуски Oracle для Windows NT не будут работать с транзакциями MTS.

База данных Oracle 8 под Windows NT

Компоненты транзакций Microsoft Transaction Server могут получить доступ к базе данных Oracle 8 под Windows NT.

В системе, содержащей компоненты Microsoft Transaction Server, необходимо установить клиентское программное обеспечение Oracle 7.3.4. Драйвер Microsoft Oracle ODBC версии 2.0 работает только с интерфейсами клиента Oracle 7.3.  Он не работает с клиентскими интерфейсами Oracle 8.

В документации Oracle 8 обсуждается установка и настройка Oracle 8 для сосуществования с клиентским программным обеспечением Oracle 7. Дополнительные сведения содержатся в приложении F в следующей публикации Oracle:

Oracle 8™
Oracle Networking Products
Release 8.0 for Windows Platforms
Getting Started

База данных Oracle 7 для UNIX

Компоненты транзакций Microsoft Transaction Server могут получить доступ к базе данных Oracle 7.3 под Unix.

Необходимо установить выпуск Oracle 7.3.3 (или более поздний) для данной системы UNIX. В большинстве случаев необходимо также установить пакет обновления Oracle 7.3.3 для Oracle под UNIX.

Обратитесь в службу поддержки Oracle, чтобы определить, что пакет обновления Oracle 7.3.3 необходим для данной системы UNIX. Объясните, что собираетесь установить доступ к базе данных Oracle под UNIX с использованием поддержки XA-транзакций, которая входит в выпуск Oracle 7.3.4 под Windows NT.

База данных Oracle 8 под UNIX

Компоненты транзакций Microsoft Transaction Server могут получить доступ к базе данных Oracle 8 под Unix.

В системе Windows NT, содержащей компоненты Microsoft Transaction Server, необходимо установить клиентское программное обеспечение Oracle 7.3.4. Драйвер Microsoft Oracle ODBC версии 2.0 работает только с интерфейсами клиента Oracle 7.3.  Он не работает с клиентскими интерфейсами Oracle 8.

Клиентское программное обеспечение Oracle

В системе Windows NT или Windows 98, содержащей компоненты Microsoft Transaction Server, необходимо установить клиентское программное обеспечение Oracle 7.3.4. Драйвер Microsoft Oracle ODBC версии 2.0 работает только с интерфейсами клиента Oracle 7.3.  Он не работает с клиентскими интерфейсами Oracle 8.

Oracle OCIW32.DLL

Необходимо установить указанную версию Oracle OCIW32.DLL в системе с Microsoft Transaction Server, которая предназначена для работы с выпуском Oracle 7.3. Эта библиотека содержится в каталоге «WIN32\V7\RSF73» компакт-диска Oracle 7.3.

На компакт-диск Oracle 7.3 имеется также более старая версия OCIW32.DLL, предназначенная для работы с выпуском Oracle 7.2. Эта библиотека содержится в каталоге «WIN32\V7\RSF72». Она не будет работать с Microsoft Transaction Server.

Известно, что следующая версия Oracle OCIW32.DLL, поставляемая в каталоге «WIN32\V7\RSF72», не работает при использовании с Microsoft Transaction Server:

Версия 7.x

Вторник, 1 февраля 1996 12:50:06 AM

Размер 36 Кбайт

Oracle XA73.DLL

Необходимо установить указанную версию Oracle XA73.DLL в системе Microsoft Transaction Server.

Microsoft Transaction Server 2.0

Если нужно получить доступ к базе данных Oracle с помощью компонентов транзакций MTS, необходимо установить Microsoft Transaction Server 2.0.

Драйвер Microsoft ODBC для Oracle

Для использования транзакций Microsoft Transaction Server необходим драйвер Microsoft ODBC версии 2.0 для Oracle (MSORCL32.DLL) версии 02.73.7283.1 или более поздней. Эта библиотека автоматически устанавливается программой установки Windows NT 4.0 Option Pack.

Если необходимо получить доступ к базе данных Oracle, предлагается использовать только драйвер Microsoft Oracle ODBC версии 2.0, даже в том случае, если не требуется поддержка транзакций. Этот новый драйвер обладает более высоким быстродействием, чем заменяемый им драйвер Oracle 1.0. Драйвер Oracle 1.0 сериализовал все активности на уровне драйвера; запросы проходили через него одним потоком. Драйвер ODBC 2.0 сериализует все активности на уровне подключения. Это позволяет различным подключениям к базам данных использоваться параллельно.

ActiveX Data Objects (ADO)

Если ваши приложения используют ADO, необходимо установить ADO версии 1.5. Предыдущие выпуски ADO не будут работать с новым диспетчером драйверов ODBC 3.5. ADO 1.5 устанавливается программой установки Windows NT 4.0 Option Pack.

Установка поддержки Oracle

 Чтобы установить поддержку Oracle для компонентов транзакций MTS:

1	Установите программное обеспечение сервера баз данных Oracle.

Установите необходимое программное обеспечение Oracle в системе сервера баз данных, как описано выше.

2	Установите клиентское программное обеспечение Oracle.

В системе Microsoft Transaction Server необходимо установить клиентское программное обеспечение Oracle 7.3.4.

Убедитесь, что установлена правильная версия библиотеки OCIW32.DLL, как описано в разделе «Необходимое программное обеспечение».

1	Установите Microsoft Transaction Server 2.0.

После установки Microsoft Transaction Server 2.0 будет установлено следующее программное обеспечение.

•	Microsoft Transaction Server 2.0, включая интерфейс Microsoft OCI

•	Диспетчер драйверов Microsoft ODBC 3.5

•	Драйвер Microsoft Oracle ODBC версии 2.0

•	ADO 1.5

1	Удалите DTCXATM.LOG.

Если бета-версия Microsoft Transaction Server 2.0 никогда не устанавливалась, пропустите данный пункт.

Если ранее была установлена бета-версия Microsoft Transaction Server 2.0, воспользуйтесь проводником Windows для обнаружения файла DTCXATM.LOG в своей системе. После этого остановите службу Microsoft DTC и удалите файл DTCXATM.LOG.

Следует удалить файл DTCXATM.LOG только один раз при первом обновлении бета-версии Microsoft Transaction Server 2.0. После этого никогда больше не удаляйте файл DTCXATM.LOG, поскольку он может содержать важные сведения для восстановления.

5	Включение поддержки XA-транзакций Oracle

Выполните следующие шаги по включению поддержки XA-транзакций Oracle:

6	Системный администратор Oracle должен создать представления, известные как V$XATRANS$. Для этого администратор должен запустить предоставляемый Oracle сценарий с именем "xaview.sql". Этот файл находится в каталоге C:\ORANT\RDBMS73\ADMIN.

7	Системный администратор Oracle должен предоставить общий доступ для операции SELECT в этих представлениях.

Grant Select on V$XATRANS$ to public.

8	В «Oracle Instance Manager» выполните команду Advanced Mode из меню View и выберите Initialization Parameters в области слева. В области справа выберите Advanced Tuning и увеличьте параметр "distributed_transactions", чтобы позволить большему числу транзакций MTS одновременно обновлять базу данных.

Дополнительные сведения о настройке поддержки XA-транзакций в Oracle см. в документации по серверу Oracle.

9	Настройка интегрированной безопасности

Интегрированная безопасность позволяет базе данных Oracle проводить проверку своих пользователей на основе проверки подлинности учетных записей Windows NT.  Это позволяет пользователю входить в Oracle без предоставления дополнительных имени и пароля. Пользователи могут иметь одинаковые имя и пароль для Windows NT и Oracle.

Если компоненты MTS всегда отправляют учетные сведения и пароль при подключении к базам данных Oracle, то интегрированная безопасность не используется. Это справедливо, если приложения прямо или косвенно указывают учетные сведения и пароль через DSN. В любом случае, если интегрированная безопасность не используется, можно пропустить данный шаг.

При использовании интегрированной безопасности необходимо настроить MS DTC для запуска с именем и паролем пользователя, который имеет право подключаться к базе данных Oracle. Это необходимо, поскольку во время восстановления базы данных MS DTC открывает эту базу данных Oracle для сообщения об исходе транзакций, находящихся в неопределенном состоянии.

Имеется возможность настроить имя пользователя для службы MS DTC следующим образом: Нажмите кнопку Пуск, выберите пункт Настройка, а затем — Панель управления. Щелкните на панели управления значок Службы. Дважды щелкните MSDTC. В группе Вход укажите имя и пароль пользователя. Воспользуйтесь средствами администрирования безопасности Oracle, чтобы для гарантировать, что указанный пользователь имеет право открывать базу данных Oracle.

Дополнительные сведения по интегрированной безопасности Oracle и Windows NT содержатся в документации Oracle.

10	Настройка Oracle на поддержку дополнительных подключений

Если нужно создать более нескольких дюжин подключений к базе данных Oracle, необходимо настроить сервер Oracle для поддержки дополнительных подключений к базе данных. См. далее раздел «Настройка Oracle для поддержки большего числа подключений ».

Проверка установки и настройки поддержки Oracle в MTS

После установки и настройки поддержки Oracle необходимо проверить установку Oracle с помощью тестовой программы, установленной вместе с MTS. Тестовая программа Oracle использует интерфейсы Oracle OCI XA во многом таким же образом, как и MTS.

Эта программа определяет, имеется ли возможность подключиться в базе данных Oracle с помощью средств Oracle XA. Тестовая программа Oracle использует стандартные интерфейсы и средства транзакций Oracle. Она не использует Microsoft Transaction Server или Microsoft Distributed Transaction Coordinator. Поэтому сбой тестовой программы указывает на то, что система Oracle неправильно установлена или настроена. При сбое тестовой программы Oracle переустановите и перенастройте Oracle, либо обратитесь за помощью в службу поддержки клиентов Oracle

 Чтобы запустить тестовую программу Oracle:

1	Убедитесь, что установлены все правильные версии программного обеспечения, описанного в разделе «Необходимое программное обеспечение».

2	Создайте файл источника данных ODBC (DSN), который ссылается на эту базу данных Oracle. Убедитесь, что DSN использует новый драйвер Microsoft Oracle ODBC 2.0.

3	Убедитесь, что включена поддержка Oracle XA.

4	Удалите все имеющиеся файлы трассировки Oracle с компьютера, содержащего компоненты MTS, которые обращаются к базе данных Oracle. Проще всего с помощью проводника Windows найти и удалить все файлы *.TRC.

При сбое тестовой программы Oracle можно попробовать определить источник неполадки с помощью файлов трассировки. Удаление всех старых файлов трассировки упрощает обнаружение созданных заново файлов.

5	Если ранее была установлена бета-версия Microsoft Transaction Server 2.0, воспользуйтесь проводником Windows для обнаружения файла DTCXATM.LOG в своей системе. После этого остановите службу Microsoft DTC и удалите файл DTCXATM.LOG.

Если бета-версия Microsoft Transaction Server 2.0 никогда не устанавливалась, пропустите данный пункт.

Следует удалить файл DTCXATM.LOG только один раз при первом обновлении бета-версии Microsoft Transaction Server 2.0. После этого никогда больше не удаляйте файл DTCXATM.LOG, поскольку он может содержать важные сведения для восстановления.

6	С командной строки MS-DOS запустите тестовую программу Oracle (TestOracleXaConfig.exe) и задайте код и пароль пользователя сервера Oracle, а также имя службы. Например,

c:>TestOracleXaConfig.exe  -U<код> -P<пароль>

-S<имя сервера, как в файле TNS>.

При запуске тестовой программы без параметров отображается справка с их описанием.

Тестовая программа отобразит сведения о каждой выполненной операции Oracle и укажет, успешно ли она выполнена.

7	Если тестовой программе Oracle удается подключится в серверу базы данных Oracle без ошибок, то очень вероятно, что MTS также будет работать с Oracle. Если тестовая программа Oracle выдает сообщения об ошибках, выполните приведенные ниже действия.

•	Точное запишите сообщение об ошибке, отображаемое тестовой программой Oracle.

•	Просмотрите файл трассировки Oracle, созданный при запуске проверочной программы Oracle. Сведения о трассировке Oracle содержатся в файле *.TRC. Файл трассировки Oracle содержит расширенные сведения об ошибках, чрезвычайно полезные при анализе неполадок.

•	Обратитесь за помощью к местному представителю Oracle.

Проверка установки и настройки поддержки Oracle с помощью приложения «Sample Bank»

После проверки установки и настройки Oracle с помощью тестовой программы Oracle имеется возможность использовать приложение «Sample Bank», поставляемое с Microsoft Transaction Server, чтобы убедиться, что Microsoft Transaction Server имеет доступ к базе данных Oracle.

 Чтобы проверить поддержку Oracle, с помощью приложения «Sample Bank»:

1	С помощью тестовой программы Oracle, поставляемой с MTS, убедитесь, что система Oracle правильно установлена и настроена. Если тестовая программа Oracle сообщает об ошибках, необходимо устранить неполадки перед продолжением операции.

2	Создайте на сервере базы данных Oracle таблицу с именем «Account». В следующем примере показано, как настроить таблицу Account.

Owner	scott

Имя таблицы	Account

Имя столбца 1	AccountNo	тип  NUMBER

Имя столбца 2	Balance	тип  NUMBER

3	Занесите в таблицу Account не менее двух строк. В следующей таблице показано, как заполнять таблицу.

AccountNo	Balance

1	1000

2	1000

1	Создайте на сервере базы данных Oracle таблицу с именем «Receipt». В следующем примере показано, как настроить таблицу Receipt.

Owner	scott

Имя таблицы	Receipt

Имя столбца 1	NextReceipt	тип  NUMBER

2	Занесите в таблицу Receipt не менее двух строк. В следующей таблице показано, как заполнять таблицу.

NextReceipt

1000

1	Создайте файл DSN с помощью программы настройки ODBC. Имя файла DSN "MTSSamples". Затем вручную обновите файл DSN, чтобы добавить пароль пользователя. В следующем примере показано, как добавлять пароль в файл DSN.

[ODBC]

DRIVER=Microsoft ODBC для Oracle

UID=scott

PWD=мой_пароль

ConnectString=мой_сервер

SERVER=мой_сервер

2	Сохраните файл DSN и запустите клиент «Sample Bank».

Администрирование Oracle и Microsoft Distributed Transaction Coordinator

Изменение имен библиотек в будущих выпусках Oracle

Oracle иногда изменяет имена библиотек (DLL), когда выпускает новые версии своего продукта. Microsoft Transaction Server основывается на известных именах некоторых библиотек Oracle. MTS в данное время ищет имена DLL, поставляемых с выпуском Oracle 7.3. Если Oracle переименует эти библиотеки, необходимо изменить значения следующих записей реестра:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Transaction Server\Local Computer\My Computer

В это разделе имеется два строковых значения.

•	OracleXaLib	"xa73.dll"

•	OracleSqlLib	"sqllib18.dll"

Изменение кода пользователя, под которым выполняется Microsoft Distributed Transaction Coordinator

Microsoft Distributed Transaction Coordinator обновляет сведения в защищенной части реестра NT. Он использует эти сведения при выполнении восстановления XA-совместимых баз данных, включая Oracle. При изменении кода пользователя, под которым выполняется MS DTC, необходимо убедиться, что MS DTC все еще имеет доступ к сведениям, которые он ранее сохранил в защищенной части реестра.

Если код пользователя MS DTC был изменен, и отсутствует доступ к сведениям в безопасной части реестра, в журнал событий Windows NT будет записано следующее сообщение.

XATM log object failed to set log encryption key

Для разрешения этой ситуации выполните следующие шаги:

1	Остановите службу MS DTC.

2	Измените код пользователя для MS DTC на его предыдущее значение. Либо задайте код пользователя, являющегося участником группы администраторов. Чтобы изменить код и пароль пользователя, щелкните значок Службы панели управления, дважды щелкните запись для MSDTC и измените значение параметра входа.

3	Вновь запустите службу MS DTC.

Настройка Oracle для поддержки большого числа подключений

Если нужно создать более нескольких дюжин подключений к базе данных Oracle, необходимо настроить сервер Oracle для поддержки дополнительных подключений к базе данных.

Если это не удается сделать, возможно проявление одной или нескольких из приведенных ниже ошибок.

?	Сбой вызовов SQLConnect.

•	Сбой подписки на транзакции с вызовом объектов, которые могут приводить к одной следующих ошибок в файле трассировки Oracle:

•	слишком большое число сеансов;

•	серверу TNS не удается найти имя сервера;

•	слишком много распределенных транзакций.

•	Превышение времени ожидания на блокировки базы данных. Это с большей вероятностью происходит, если настроенное число блокировок недостаточно для числа одновременно активных транзакций.

•	Конфликты записи из-за блокировки, накладываемой транзакциями в неопределенном состоянии.

При обнаружении одной из указанных неполадок, увеличьте следующие параметры настройки сервера Oracle:

Параметр настройки Oracle

sessions

distributed_lock_timeout

distributed_transactions

dml_locks

max_transaction_branches

open_cursors

processes

queuesize

Sessions

Значение параметра sessions обычно должно в три раза превосходить полное число подключений к базам данных, которое ожидается от ваших приложений.

Queuesize

Если значение параметра queue size не подходит для процесса Oracle Listener, иногда возникает сбой этого процесса, и остаются открытые запросы к базам данных. Это происходит, если процесс Oracle Listener получает слишком большое число запросов подключений и его очередь переполняется. Клиент, который встречает данную ошибку, сообщает об ошибке ‘ORA-12541: Ни один процесс Listener и файлы журнала или трассировки клиента не выводят сообщение ECONREFUSED.

  Чтобы устранить неполадку с запросом на подключение:

1	Остановите процесс Oracle listener в системе, содержащей сервер базы данных Oracle.

2	Увеличьте параметр QUEUESIZE в файлах LISTENER.ORA, TNSNET.ORA или NAMES.ORA в системе сервера базы данных Oracle. Выберите размер очереди основе предполагаемого числа одновременных или почти запросов подключения.

Желательно выбрать для QUEUESIZE наиболее общее значение, поскольку система Oracle обычно открывает более одного подключения к базе данных для каждого подключения транзакции, которое открывает приложение. В результате процесс Oracle Listener может переполниться.

Чтобы принять 100 запросов, измените файл LISTENER.ORA следующим образом:

QUEUESIZE = 100

3	Перезапустите процесс Oracle Listener

Известные ограничения поддержки Oracle в MTS

При использовании с ODBC 3.5 требуется ADO версии 1.5

Если приложения используют ADO, убедитесь, что установлена ADO версии 1.5. Дополнительные сведения содержатся в разделе Необходимое программное обеспечение.

Отсутствует поддержка Oracle для систем Digital Alpha

Подключение к базам данных Oracle не поддерживается для компонентов Microsoft Transaction Server, работающих в системах с процессором Alpha фирмы Digital. Поддержка Oracle в системах Digital Alpha будет добавлена в выпуске Visual Studio 6.

Ошибка версии OCIW32.DLL

Важно, чтобы на компьютере была установлена правильная версия OCIW32.DLL. Версию этой библиотеки следует проверять при каждой переустановке Oracle или Microsoft Transaction Server.

Изменение имен библиотек в будущих выпусках Oracle

Oracle иногда изменяет имена библиотек (DLL), когда выпускает новые версии своего продукта. Microsoft Transaction Server основывается на известных именах некоторых библиотек Oracle. В данное время MTS ищет имена библиотек, предоставляемые в Oracle версии 7.3.3. Поскольку MTS не может предугадать будущие имена этих библиотек, возможно потребуется изменить значения следующего раздела реестра при обновлении установки Oracle:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Transaction Server\Local Computer\My Computer

В это разделе имеется два строковых значения.

•	OracleXaLib	"xa73.dll"

•	OracleSqlLib	"sqllib18.dll"


Установка учебного приложения MTS «Sample Bank»

Приложение «Sample Bank» представляет собой банковское приложение, которое получает и отправляет деньги на счет, а также передает деньги между счетами. Запуск приложения «Sample Bank» позволяет проверять установку MTS с SQL Server 6.5, а также осваивать развертывание и администрирование пакетов. Приложение «Sample Bank» имеет компоненты, написанные на Visual Basic, Visual C++ и Visual J++, и находится в каталоге \Program Files\Mts\Samples.

0	Руководство программиста MTS содержит подробный учебник с описанием, как собрать компоненты приложения «Sample Bank».

1	Чтобы запустить приложение «Sample Bank»:

•	Выберите Выборочную установку и выделите все дополнительные компоненты MTS. Дополнительные сведения содержатся в разделе Установка примеров и документации для разработчика MTS.

•	Настройте DSN.

•	Установите пакет Sample Bank.

•	Настройте MTS Explorer для наблюдения за пакетом Sample Bank.

•	Запустите «Bank Client».

Установка учебного приложения MTS «Sample Bank»

MTS автоматически настраивает источник данных ODBC для приложения «Sample Bank» в процессе установки. Поскольку локальный компьютер используется по умолчанию, необходимо установить на него SQL Server 6.5.

По умолчанию MTS DSN указывает на SQL Server 6.5. При использовании базы данных, отличной от SQL Server 6.5, необходимо удалить DSN и добавить новый DSN с именем MTSSamples, который указывает на эту базу данных.

Если требуется использовать установку SQL Server с другого компьютера, воспользуйтесь значком службы ODBC на панели управления, чтобы следующим образом изменить источник данных:

•	В диалоговом окне Источники данных выберите вкладку Файловый, а затем выберите источник данных с именем MTSSamples.

•	Нажмите кнопку Настройка и введите имя нужного сервера.

Следует отметить, что имя и пароль, указанные в MTSSamples DSN, не используются приложением «Sample Bank». Приложение «Sample Bank» использует учетную запись "sa" без пароля. Если пароль системного администратора задан, или нужно указать другую учетную запись, необходимо изменить строку подключения ODBC в исходном тексте программ «Sample Bank».

Чтобы наблюдать за компонентами пакета Sample Bank и транзакциями:

1	Дважды щелкните значок пакета Sample Bank в правой области MTS Explorer.

2	Дважды щелкните папку «Компоненты».

3	Для отображения сведения об использовании различных компонентов пакета выполните команду Состояние из меню Вид.

4	Выполните команду Создать из меню Окно.

5	Упорядочите новое окно, так чтобы два окна не перекрывались. Расположите окна с помощью команды Каскадом или Сверху вниз из меню Окно.

6	Щелкните Статистика транзакций в левой области нового окна.

7	Выполните команду Область объектов из меню Действие, чтобы снять установленные флажки и скрыть область слева. Теперь статистика транзакций будет отображаться при использовании компонентов транзакций.

Чтобы запустить «Bank Client»:

1	Убедитесь, что Microsoft Distributed Transaction Coordinator (MS DTC) запущен. Выберите Мой компьютер в левой части Transaction Server Explorer. Выполните команду Запустить MS DTC из меню Действие, если она доступна.

2	Убедитесь, что SQL Server запущен. Можно запустить SQL Server с панели управления.

2	Нажмите кнопку Пуск и выполните команды Программы, Microsoft Transaction Server, Примеры, а затем —Bank Client. Разместите окно «Bank Client», чтобы оно не перекрывало окна MTS Explorer.

3	В форме по умолчанию получается $1 на счет номер 1. Щелкните кнопку Submit. Отображаются результаты с новыми значениями.

4	Просмотрите окна MTS Explorer. Окна использования компонентов и статистики транзакций были обновлены.

5	Поупражняйтесь с банковским клиентом и просмотрите статистику использования разных типов транзакций, серверов и итераций. Первая транзакция занимает больше времени, чем последующие транзакции по следующим причинам:

•	при первой транзакции создаются таблицы банковской базы данных и вставляются временные записи;

•	начало серверного процесса использует дополнительные системные ресурсы;

•	открытие подключений к базе данных в первый раз является затратной серверной операцией.


Установка учебного приложения MTS «Tic-Tac-Toe»

Учебное приложение «Tic-Tac-Toe» представляет собой игру, в которую можно играть с компьютером или с партнером на удаленном компьютере с MTS. Запуск приложения «Tic-Tac-Toe» позволяет проверить установку MTS с SQL Server, а также освоить развертывание и администрирование пакетов. Учебное приложение «Tic-Tac-Toe» содержится в каталоге \Program Files\Mts\Samples.

Чтобы запустить это приложение:

•	установите Microsoft Transaction Server;

•	запустите клиент «Tic-Tac-Toe» и начните игру с компьютером или другим пользователем.

Чтобы запустить клиент Tic-Tac-Toe:

1	Запустите tClient.exe, расположенный в папке установки MTS на верхнем уровне.

2	Введите свое имя в поле Your Name is …, а затем выберите игру против компьютера (Deep Viper) или другого пользователя. Сведения об игре против удаленного пользователя см. в разделе Работа с удаленными компьютерами MTS.

После начала игры вернитесь в MTS Explorer. Отметьте, что значок серверного компонента «Tic-Tac-Toe» теперь вращается, указывая, что он активизирован, и MTS был установлен правильно. При остановке игры значок прекращает вращение, поскольку клиент «Tic-Tac-Toe» больше не использует серверный компонент «Tic-Tac-Toe».

Если выполнить команду Состояние из меню Вид, имеется возможность получить сведения об использовании компонента «Tic-Tac-Toe».


Установка учебных административных сценариев MTS

Примеры сценариев объектов администрирования показывают как писать сценарии на языке поддерживающем программирование объектов (Automation), например на Visual Basic Scripting Edition (VBScript), которые автоматизируют процедуры в MTS Explorer. Примеры сценариев автоматизируют развертывание приложения «Sample Bank».

Чтобы запустить сценарии, необходимо сначала установить Windows Scripting Host (WSH). Следует отметить, что сценарии работают только в системе Microsoft Windows NT и в системах на процессоре Alpha.

Чтобы установить Windows Scripting Host из пакета Windows NT 4.0 Option Pack:

1	Если WSH уже был установлен, нажмите кнопку Пуск и выполните команды Microsoft Internet Information Server, Установка Internet Information Server.

2	Нажмите кнопку Добавит/Удалить.

3	Найдите Windows Scripting Host в списке компонентов и установите его флажок.

4	Нажмите кнопку Готово. Программа установки Windows NT 4.0 Option Pack установит WSH на компьютер.

После установки WSH имеется возможность использовать примеры сценариев объектов администрирования. Следующие сценарии находятся в папке \Program Files\Mts\Samples:

•	InstDLL.vbs

Он удаляет имеющиеся версии приложений «Sample Bank», создает новый пакет с именем «Sample Bank», устанавливает компоненты «Sample Bank» из библиотек (DLL) Visual Basic, Visual C++ и Visual J++ в новый пакет, изменяет атрибуты транзакций и добавляет новую роль. Необходимо изменить путь к файлу перед запуском этого сценария.

Следует отметить, что данному сценарию необходимо, чтобы реестр компьютера содержал все программные идентификаторы компонентов (progIDs). Поэтому необходимо использовать мастер Visual Studio 97 ActiveX Wizard для регистрации компонентов Java перед запуском этого сценария.

•	InstPak.vbs

Устанавливает пакет «Sample Bank» в среде выполнения MTS. Необходимо изменить путь к файлу перед запуском этого сценария.

•	Uninst.vbs

Удаляет установку пакета «Sample Bank» в среде выполнения MTS. Необходимо изменить путь к файлу перед запуском этого сценария.

•	InstDllCLI.vbs

Позволяет запустить сценарий InstDll.vbs из окна консоли и ввести путь к файлу в качестве параметра для удаления существующих версий приложения «Sample Bank», создает новый пакет с именем «Sample Bank», устанавливает компоненты из библиотек «Sample Bank» для Visual Basic, Visual C++ и Visual J++ в этот новый пакет, изменяет атрибуты транзакций и добавляет новую роль.

•	InstPakCLI.vbs

Позволяет запустить сценарий InstPak.vbs в окне консоли и ввести путь к файлу в качестве параметра для установки пакета «Sample Bank» в среду выполнения MTS.

Дополнительные сведения о используемых в сценариях объектах администрирования и примерах сценариев содержатся в разделе Автоматизация администрирования MTS руководства администратора MTS.

Ограничения учебных сценариев администрирования

•	Компоненты Java должны быть зарегистрированы с помощью мастера Visual Studio 97 ActiveX Wizard перед запуском сценария InstDLL.vbs.

•	Установка компонентов Java с помощью учебных сценариев поддерживается только на компьютерах с процессором типа Alpha или i386. Пользователи компьютеров с процессором Alpha должны удалить компонент Java, импортирующий программу из InstDLL.vbs, перед запуском данного сценария.


Получение справки при работе с MTS

Для получения справки в процессе работы имеются следующие источники.

•	Документация

•	Основная страница Microsoft Transaction Server: http://www.microsoft.com/transaction/.

•	Службы поддержки продукта.

Документация

Документация по MTS содержит концептуальные, ориентированные на выполнение задач и ссылочные сведения о возможностях MTS. Имеется также возможность получить контекстную справку при использовании MTS Explorer и ключевых слов языка программирования, нажав клавишу F1. Контекстная справка выдается сразу после нажатия клавиши F1 без предварительного выбора меню ?.

См. также   Документация по MTS


Руководство администратора MTS

Руководство администратора MTS описывает, как и когда использовать Microsoft® Transaction Server Explorer для создания, установки, распространения и обновления пакетов. Это руководство содержит сведения для следующих пользователей:

•	системных администраторов;

•	Web-администраторов;

•	разработчиков приложений.

Разработчики могут обращаться к данным процедурам при создании, развертывании и распространении приложений MTS. Системные администраторы и Web-администраторы могут воспользоваться сгруппированными по задачам MTS Explorer процедурами для развертывания, администрирования и обновления приложений MTS.

В следующих разделах описывается, что означает развертывание и администрирование пакетов с помощью MTS Explorer, и предоставляются ссылки на более развернутые разделы:

Что означает создание пакета MTS

Что означает распространение пакета MTS

Что означает установка пакета MTS

Что означает обновление пакета MTS

Что означает управление транзакцией MTS

Что означает автоматизация администрирования MTS

MTS Explorer под Windows 98

Имеется возможность управлять пакетами MTS с помощью MTS Explorer в операционной системе Windows® 98. Однако администрирование MTS под Windows 98 имеет следующие ограничения:

•	Запуск службы Remote Registry на компьютере с системой Windows 98 позволяет воспользоваться компьютером Windows NT для удаленного администрирования компьютера Windows 98. Служба Remote Registry разрешает изменять записи реестра удаленного компьютера Windows 98 (предоставляя нужные разрешения).

Чтобы найти службу Remote Registry, перейдите в каталог \Admin\Nettols\RemoteReg на компакт-диске Windows 98. Просмотрите инструкции по установке службы Remote Registry содержатся  в файле Regserv.txt, в затем запустите программу установки Remote Registry (Regserv.exe).

•	Невозможно удаленно администрировать MTS, работающий под Windows 98, с другого компьютера Windows 98 или Windows NT.

•	Область иерархической структуры в левой части окна MTS Explorer не отображается. Чтобы осуществлять перемещения: для перехода вниз по иерархии дважды щелкните значок, а для возврата вверх по иерархии щелкните кнопку панели инструментов На один уровень вверх.

•	Поскольку служебная программа для исполняемого файла приложения не поддерживается под Windows 98, невозможно использовать MTS Explorer для создания исполняемых файлов. Дополнительные сведения о служебной программе для исполняемого файла приложения содержатся в разделе Создание исполняемых файлов MTS.

•	Администрирование Windows 98 не поддерживает свойств безопасности или ролей MTS. Таким образом, отсутствует возможность просматривать папки «Роли», «Используемые роли» или «Пользователи» в окне Explorer.

•	Чтобы добавить пользователя для роли на компьютере с системой Windows 98, необходимо настроить на компьютере Windows 98 управление доступом на уровне пользователей.

Для этого откройте панель управления Windows 98 и щелкните значок Сеть. Выберите вкладку Управление доступом, а затем выберите параметр "На уровне пользователей".  За дополнительными сведениями обращайтесь к документации Windows 98 Resource Kit.

•	К компонентам, работающим под Windows 98, отсутствует удаленный доступ с клиента на другом компьютере.

•	Поскольку Windows 98 не имеет системный журнал событий, записи журнала событий записываются в файл HTML с именем «Transaction Server.html», расположенный в подкаталоге \MTSLogs каталога Windows. Имеется возможность использовать этот файл HTML для отслеживания любых значительных событий в системе или программе.

•	Известно, что если серверный процесс MTS останавливается непредвиденно (из-за нарушения политики обхода сбоев (failfast), защиты или прав доступа), при последующих попытках перезапуска приложения создаются несколько процессов MTS. (При правильном поведении должно быть по одному процессу MTS на пакет.) В случает непредвиденной остановки серверного процесса необходимо перезагрузить компьютер с системой Windows 98.

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server


Что означает создание пакета MTS

Создание пакетов составляет конечный шаг в процессе разработки. Разработчики пакетов и опытные системные администраторы и администраторы Web используют MTS Explorer для создания и развертывания пакетов. Окно Explorer используется для выполнения настройки пакетов и компонентов, которая определяется во время разработки приложения.

Дополнительные сведения о разработке и сборке приложений MTS содержатся в разделе Построение приложений для MTS руководства программиста MTS.

Процедуры:

Создание пустого пакета MTS

Добавление компонента в пакет MTS

Импорт компонента в пакет MTS

Удаление компонента из пакета MTS

Сборка пакета MTS для экспорта

Задание свойств пакета MTS

Задание свойств активизации MTS

Задание свойств транзакций MTS

Здание уровней проверки подлинности MTS

Блокировка пакета MTS

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server, Что означает распространение пакета MTS, Что означает установка пакета MTS, Что означает обновление пакета MTS, Что означает управление транзакцией MTS, Что означает автоматизация администрирования MTS


Что означает распространение пакета MTS

После сборки и упаковки компонентов приложения MTS, приложение распространяется для клиентов. Это выполняется следующими способами:

•	Перенесите компоненты с компьютера сервера на серверный компьютер системного администратора или администратора Web-узла с помощью MTS Explorer. В этом случае требуется, чтобы на обоих серверных компьютерах работал MTS.

•	Воспользуйтесь служебной программой для исполняемого файла приложения в MTS Explorer для автоматического создания исполняемых файлов приложений, ссылающихся на удаленный сервер. Клиентское приложение не должно иметь запущенный MTS.

Желательно использовать служебную программу для исполняемых файлов приложений MTS Explorer для распространения серверного пакета среди клиентов, которые имеют или не имеют MTS на своих компьютерах. Исполняемый файл приложения автоматически настраивает клиентский компьютер на доступ к компонентам, выполняющимся на удаленном сервере MTS. Имеется также возможность настроить удаленные компоненты вручную с помощью MTS Explorer.

Хотя для использования служебной программы для исполняемых файлов приложений не требуется навыков программирования, распространители приложений MTS должны быть хорошо знакомы со значением упаковки и доставки клиентских и серверных приложений. Например неправильная упаковка приложения может привести к передаче клиентам кода серверного приложения в клиентском исполняемом файле.

Процедуры:

Работа с удаленными компьютерами MTS

Экспорт пакетов MTS

Создание исполняемых файлов MTS

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server, Что означает создание пакета MTS, Что означает установка пакета MTS, Что означает обновление пакета MTS, Что означает управление транзакцией MTS, Что означает автоматизация администрирования MTS


Что означает установка пакета MTS

После создания пакета он развертывается и настраивается, для чего необходимы знания свойств пакета и компонентов. Например после установки пакета системный администратор или Web-администратор должен сопоставить пользователей Windows NT с ролями, связанными с данным пакетом. Системный администратор или администратор узла Web должен хорошо понимать основанную на ролях декларативную безопасность и роли, связанные с приложением, перед сопоставлением пользователей и групп приложения с ролями.

Процедуры:

Установка готовых пакетов MTS

Обновление пакетов MTS

Включение безопасности пакета MTS

Задание удостоверения пакета MTS

Добавление новой роли MTS

Сопоставление ролей MTS с пользователями и группами

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server, Что означает создание пакета MTS, Что означает распространение пакета MTS, Что означает обновление пакета MTS, Что означает управление транзакцией MTS, Что означает автоматизация администрирования MTS


Что означает обновление пакета MTS

Имеется возможность использовать окно MTS Explorer для обновления приложений MTS, наблюдая за состоянием установленных пакетов и перенастраивая свойства компонента и пакета, если нужно. В данном разделе описывается, как перенастроить пакеты, которые уже были развернуты и настроены.

Процедуры:

Наблюдение за состоянием и свойствами в MTS Explorer

Использование окон свойств в MTS Explorer

Выбор пользователей для ролей MTS

Использование репликации MTS

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server, Что означает создание пакета MTS, Что означает распространение пакета MTS, Что означает установка пакета MTS, Что означает управление транзакцией MTS, Что означает автоматизация администрирования MTS


Что означает управление транзакцией MTS

Администратор должен представлять, как работают распределенные транзакции, чтобы понимать контекст, в котором выполняется управление транзакциями в MTS Explorer. В данном разделе обсуждаются транзакции и состояния транзакций, а также наблюдение и управление транзакциями, администрирование которых осуществляется.

Процедуры:

Представление о транзакциях MTS

Управление MS DTC

Наблюдение транзакций MTS

Наблюдение транзакций MTS под Windows 98

Представление о состояниях транзакций MTS

Определение транзакций MTS

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server, Что означает создание пакета MTS, Что означает распространение пакета MTS, Что означает установка пакета MTS, Что означает обновление пакета MTS, Что означает автоматизация администрирования MTS


Что означает автоматизация администрирования MTS

Администрирование с помощью сценариев позволяет автоматизировать настройку пакетов и компонентов в MTS Explorer. Обладая необходимыми знаниями языка сценариев такого как Microsoft Visual Basic, имеется возможность использовать объекты сценариев для автоматизации задач администрирования в окне Explorer. Например разработчики инструментов могут также использовать объекты сценариев для создания надстроек MTS Explorer, например таких, которые автоматически настраивают удаленных клиентов.

Примечание.   Использование объектов сценариев требует рабочих знаний языка сценариев с программированием объектов (Automation).

Чтобы получить примеры административных сценариев и справочник администрирования MTS, содержащий страницы со ссылками на интерфейсы программирования приложений (API) Microsoft Visual Basic и Microsoft Visual C++ и примеры программ для объектов сценариев, необходимо установить примеры для разработчиков MTS и соответствующую документацию. Примеры административных сценариев написаны на языке Visual Basic Script и используют преимущества программы Windows Scripting Host, которую можно установить с помощью программы установки Windows NT 4.0 Option Pack. Дополнительные сведения об использовании административных сценариев содержатся в разделе Установка учебных административных сценариев MTS.

Процедуры:

Объекты администрирования MTS

Пример сценария Visual Basic для автоматизации администрирования MTS

Пример приложения Visual Basic для автоматизации администрирования MTS

Автоматизация администрирования MTS с помощью Visual Basic

Автоматизация расширенного администрирования MTS с помощью Visual Basic

См. также

Краткое руководство по Microsoft Transaction Server, Приступая к работе с Microsoft Transaction Server, Что означает создание пакета MTS, Что означает распространение пакета MTS, Что означает установка пакета MTS, Что означает обновление пакета MTS, Что означает управление транзакциями MTS


Иерархическая структура окна MTS Explorer

MTS Explorer представляет собой наглядный инструмент, используемый для управления пакетами и компонентами MTS, выполняющимися в среде выполнения MTS. MTS Explorer используется для выполнения разных задач: от установки компонентов в пакетах и до наблюдения за состоянием транзакций.

MTS Explorer представляет собой объект snap-in на консоли MMC (Microsoft Management Console) в системе Windows NT и исполняемый файл (mtxpd.exe) в системе Windows 98. В левой области с иерархической структурой окна Explorer содержатся следующие папки:

•	Компьютеры

Содержит компьютеры, управляемые с данного сервера. Локальный компьютер имеет имя «Мой компьютер».

•	Установленные пакеты

Содержит пакеты, установленные на данный компьютер.

•	Удаленные компоненты

Содержит компоненты удаленных компьютеров, используемые пакетами на данном компьютере.

•	Список транзакций

Отображает текущие транзакции, в которых принимают участие приложения MTS.

•	Статистика транзакций

Отображает статистику транзакций, в которых принимает участие локальный компьютер.

•	Сообщения трассировки

Перечисляет текущие сообщения трассировки, выданные службой Microsoft Distributed Transaction Coordinator (MS DTC).

Примечание MTS Explorer под Windows 98 имеет одну область. Чтобы осуществлять перемещения по иерархии в Windows 98: для перехода вниз по иерархии дважды щелкните значок, а для возврата вверх по иерархии щелкните кнопку панели инструментов На один уровень вверх.

Кроме того, под Windows 98 невозможно использовать папку «Удаленные компоненты» или служебную программу для исполняемых файлов приложения.

Ограничения MTS Explorer под Windows 98 содержатся в подразделе MTS Explorer под Windows 98 раздела «Руководство администратора MTS».

Удаленные компьютеры, управляемые с помощью MTS Explorer, содержат под значком компьютера структуру окон «Установленные пакеты», «Удаленные компоненты», «Список транзакций», «Статистика транзакций» и «Сообщения трассировки».

Каждый установленный пакет содержит в MTS Explorer следующие вложенные папки:

•	Компоненты

Содержит установленные компоненты выбранного пакета.

•	Роли

Содержит роли, доступные в пакете.

•	Используемые роли

Содержит роли, присвоенные выбранному компоненту или интерфейсу компонента.

•	Пользователи

Содержит пользователей, сопоставленных с ролью пакета.

•	Интерфейсы

Содержит интерфейсы для выбранного компонента.

•	Методы

Содержит методы для выбранного интерфейса.

См. также

Краткое руководство по Microsoft Transaction Server


Папка «Компьютеры»

Папка «Компьютеры» содержит «Мой компьютер» и другие компьютеры, добавленные в эту папку. По умолчанию Мой компьютер соответствует локальному компьютеру, на котором установлен MTS.

Имеется возможность добавить компьютер в папку «Компьютеры» одним из следующих способов:

•	щелкнув правой кнопкой мыши папку «Компьютеры» и выполнив команды Создать, а затем — Компьютер;

•	выбрав папку «Компьютер» и щелкнув значок Создать новый объект на панели инструментов в области справа;

•	выбрав папку «Компьютеры» и выполнив команду Создать из меню Действие в левой области окна Explorer.

Введите имя сервера, который хотите администрировать со своего компьютера, в диалоговом окне Добавление компьютера. Новый сервер добавляется в папку «Компьютеры» под значком «Мой компьютер» в структуре окна MTS Explorer.

См. также

Мой компьютер, Свойства компьютера


Мой компьютер

«Мой компьютер» соответствует локальному компьютеру, на котором установлен MTS.

Процедуры, доступные на уровне папки «Компьютер» содержатся в следующих разделах:

Использование репликации MTS

Управление MS DTC

Все папки компьютеров содержит следующие папки:

Установленные пакеты

Содержит установленные пользователем и системные пакеты, управляемые с данного компьютера.

Удаленные компоненты

Содержит компоненты с удаленных компьютеров, вызываемые пакетами на локальном компьютере.

Список транзакций

Перечисляет текущие транзакции, которые управляются с данного компьютера.

Статистика транзакций

Отображает статистику транзакций, в которых принимает участие компьютер.

Сообщения трассировки

Перечисляет текущие сообщения трассировки, выданные службой Microsoft Distributed Transaction Coordinator (MS DTC).

Как и для любого компьютера из папки «Компьютеры» свойства объекта «Мой компьютер» могут быть настроены с помощью окна свойств со следующими вкладками:

•	Общие

•	Параметры

•	Дополнительно

См. также

Папка «Компьютеры»


Папка «Установленные пакеты»

Папка «Установленные пакеты» содержит список всех пакетов, добавленных на данный компьютер. На уровне пакета имеется возможность выполнить следующие функции:

Создание пустого пакета MTS

Установка готовых пакетов MTS

Обновление пакетов MTS

Задание свойств пакета MTS

Задание свойств активизации MTS

Задание удостоверения пакета MTS

Включение безопасности пакета MTS

Задание свойств транзакций MTS

Блокировка пакета MTS

Экспорт пакетов MTS

Наблюдение за состоянием и свойствами в MTS Explorer

Использование окон свойств в MTS Explorer

Папка «Установленные пакеты» содержит также следующие системные пакеты:

System

Utilities

Примечание. Это внутренние пакеты MTS, и, обычно, они не должны изменяться или настраиваться пользователями. Однако может потребоваться настроить внутренний пакет MTS, чтобы расширить или ограничить привилегии сервера MTS. Например, чтобы установить административные привилегии для пользователя на сервере MTS, этот пользователь добавляется к роли Administrator для пакета System.

В папку «Установленные пакеты» имеется возможность установить любое число пакетов. Каждый установленный пакет содержит следующие вложенные папки.

•	Компоненты

Содержит установленные компоненты выбранного пакета.

•	Роли

Содержит роли, присвоенные выбранному пакету.

Свойства пакета могут настраиваться с помощью следующих окон свойств:

•	Общие

•	Безопасность

•	Дополнительно

•	Удостоверение

•	Активизация

При использовании MTS с Internet Information Server (IIS) версии 4.0 папка «Установленные пакеты» содержит также следующие специальные системные пакеты IIS:

•	внутренние приложения IIS

Папка внутренних приложений IIS содержит компоненты для каждого приложения Internet Information Server (IIS), запускаемого в процессе IIS. Приложение IIS может выполняться в процессе IIS или в отдельном процессе приложения. Если приложение IIS выполняется в процессе IIS, оно отображается в качестве компонента папки внутренних приложений IIS. Если приложение IIS выполняется в индивидуальном процессе приложения, оно отображается в качестве отдельного пакета в структуре окна MTS Explorer.

•	служебные программы IIS

Папка служебных программ IIS содержит компонент ObjectContext, необходимый для включения транзакций активных серверных страниц (Active Server Pages). Дополнительные сведения о транзакциях ASP (Active Server Pages) содержатся в документации по Internet Information Server (IIS).

Microsoft Transaction Server использует компонент ObjectContext для внутренних функций. Имеется возможность просматривать, но не задавать свойства данного компонента.

Примечание. При создании безопасных приложений IIS, использующих изолированность процессов, IIS создает пакет MTS, который предназначен для запуска с именем IWAM_<имя компьютера>. Если нужно изменить удостоверение таких пакетов, следует добавить новое удостоверение пакета в группу «MTS Impersonators», или система безопасности не будет работать в других внешних компонентах MTS, вызываемых пакетом. Если это не выполнено, вызывающим клиентом будет, по-видимому, являться IWAM_<имя компьютера>, а не действительный клиент IIS.


Пакет «Utilities»

Пакет Utilities включает два компонента: TransactionContext и TransactionContextEx. Имеется возможность использовать TransactionContext/TransactionContextEx в своих базовых клиентах для объединения работы одного или нескольких объектов Microsoft Transaction Server в целостной транзакции, а также для прерывания или завершения транзакции.

См. также

Управление транзакциями MTS


Пакет «System»

Пакет System включает компоненты, которые не могут быть изменены. Microsoft Transaction Server использует эти компоненты для внутренних функций. Имеется возможность просматривать, но не задавать свойства компонента System.

Чтобы пользователь смог удалить или изменить пакеты, управляемые с помощью MTS Explorer, этот пользователь должен быть сопоставлен с ролью Administrator для пакета System. Если MTS установлен на сервере, играющем роль основного или резервного контроллера домена, то, чтобы управлять пакетами в MTS Explorer, пользователь должен быть администратором домена.

См. также

Настройка сервера MTS, Включение безопасности пакета MTS, Сопоставление ролей MTS с пользователями и группами, Папка «Пользователи»


Папка «Компоненты»

Папка «Компоненты» содержит компоненты выбранного пакета.

Процедуры, доступные на уровне компонентов, описываются в следующих разделах:

Добавление компонента в пакет MTS

Импорт компонента в пакет MTS

Удаление компонента из пакета MTS

Наблюдение за состоянием и свойствами в MTS Explorer

Использование окон свойств в MTS Explorer

Задание свойств транзакций MTS

Настройка ролей MTS для декларативной безопасности

Папка «Компоненты» содержит следующие вложенные папки:

•	Интерфейсы

Содержит интерфейсы, связанные с выбранным компонентом.

•	Используемые роли (Компоненты)

Содержит роли и пользователей, связанных с ролями для выбранного компонента.

Свойства компонента могут настраиваться с помощью следующих окон свойств:

•	Общие

•	Транзакции

•	Безопасность

См. также

Задание свойств активизации MTS


Папка «Роли»

Папка «Роли» содержит роли выбранного пакета. MTS позволяет определять роли, которые определяют доступ пользователя к пакету, компоненту или интерфейсу. Любую роль, добавляемую в папку «Роль» для выбранного пакета, можно также добавить в папку «Используемые роли» для компонента или интерфейса данного пакета.

На уровне ролей имеется возможность выполнить следующие функции:

Сопоставление ролей MTS с пользователями и группами

Включение безопасности пакета MTS

Добавление новой роли MTS

Папка «Роли» имеет одну вложенную папку:

•	Пользователи

Свойства роли могут настраиваться с помощью следующих окон свойств:

•	Общие

См. также

Настройка сервера MTS, Пакет «System»


Папка «Интерфейсы»

Папка «Интерфейсы» содержит интерфейсы, определенные для выбранного компонента.

Папка «Интерфейсы» содержит две вложенные папки:

•	Методы

•	Используемые роли

Свойства интерфейса могут просматриваться с помощью следующих окон свойств:

•	Общие

•	Proxy

Следует отметить, что невозможно настроить свойства интерфейса, кроме как предоставив описание интерфейса на вкладке «Общие» окна свойств.

См. также

Включение безопасности пакета MTS


Папка «Методы»

Папка «Методы» содержит методы, определенные для выбранного интерфейса.

Свойства метода отображаются в одном окне:

•	Общие

Невозможно настроить метод, кроме как добавляя его описание в окне свойств.

См. также

Папка «Интерфейсы»


Папка «Используемые роли»

Папка «Используемые роли» содержит роли, которые были связаны с компонентом или интерфейсом. При добавлении в эту папку ролей из папки «Роли» пакета определяются пользователи, имеющие доступ к интерфейсу или компоненту.

Свойства используемых ролей задаются на уровне папки «Роли». Например описание, введенное для роли пакета, будет отображаться для этой роли на уровне папки «Используемые роли».

Декларативная безопасность описывается в разделе Включение безопасности пакета MTS.

См. также

Папка «Интерфейсы»


Папка «Пользователи»

Папка «Пользователи» содержит пользователей или группы Windows NT, сопоставленные с ролью. Каждый пользователь представляет учетную запись пользователя Windows NT, добавленную в папку «Роли» пакета. Имеется возможность управлять доступом к пакетам, компонентам и интерфейсам, добавляя учетные записи пользователей или групп Windows NT в папку «Роли».

На уровне папки «Пользователи» имеется возможность выполнить следующие функции:

Добавление нового пользователя к роли

Удаление пользователя из роли

Отсутствует окно свойств, связанное с папкой «Пользователи».

См. также

Включение безопасности пакета MTS, Сопоставление ролей MTS с пользователями и группами


Папка «Удаленные компоненты»

Папка «Удаленные компоненты» содержит компоненты, зарегистрированные локально на одном компьютере для удаленного запуска на другом компьютере. Для использование папки «Удаленные компоненты» требуется иметь установленный MTS на компьютерах клиентов, которые нужно настроить. Если нужно настроить удаленные компьютеры вручную с помощью окна Explorer, добавьте компоненты, к которым будет осуществляться доступ с удаленных компьютеров в папку «Удаленные компоненты».

Следует отметить, что перед настройкой удаленных компонентов необходимо добавить в свою папку «Компьютеры» все дополнительные серверы, на которых будут запускаться  удаленные компоненты.

Дополнительные сведения о работе с удаленными компьютерами, на которых установлен MTS, содержатся в следующих разделах:

Экспорт пакетов MTS

Работа с удаленными компьютерами MTS

Примечание.   К компонентам, работающим под Windows 98, отсутствует удаленный доступ с клиента на другом компьютере. См. подраздел MTS Explorer под Windows 98 раздела Руководство администратора MTS.

См. также

Создание исполняемых файлов MTS


Список транзакций

Окно Список транзакций отображает текущие транзакции, в которых участвует данный компьютер, включая:

•	транзакции, состояние которых не определено;

•	транзакции, остающиеся в одном и том же состоянии в течение времени, указанного на вкладке Дополнительно окна свойств компьютера.

Описание значков, отображаемых в окне «Список транзакций» содержатся в разделе «Значки транзакций».

Обзор обработки транзакций содержится в следующих разделах:

•	Представление о транзакциях MTS

•	Представление о состояниях транзакций MTS

Окно Список транзакций предназначено для выполнения следующих задач:

•	Наблюдение транзакций MTS

•	Наблюдение транзакций MTS под Windows 98

•	Разрешение транзакций MTS

Для просмотра свойств транзакции можно также щелкнуть правой кнопкой мыши выбранную транзакцию и выполнить команду Свойства.

См. также

 Значки транзакций, Управление MS DTC


Статистика транзакций

В окне Статистика транзакций отображается статистика транзакций, в которых участвует компьютер. Некоторые характеристики являются накопительными; другие отражают текущее быстродействие.

Обзор обработки транзакций содержится в следующих разделах:

•	Представление о транзакциях MTS

•	Представление о состояниях транзакций MTS

Окно Статистика транзакций предназначено для выполнения следующих задач:

•	Наблюдение транзакций MTS

•	Наблюдение транзакций MTS под Windows 98

•	Разрешение транзакций MTS

Следует отметить, что с помощью MTS Explorer под Windows NT можно открыть только одно окно «Статистика транзакций» для данного сервера.

Текущая

•	Активно — Текущее число транзакций, которые еще не завершены по двухэтапному протоколу завершения.

•	Макс. активно —  Наибольшее число активных транзакций в любое время в процессе текущего сеанса Microsoft Distributed Transaction Coordinator (MS DTC).

•	Не определено —  Текущее число транзакций, которые невозможно завершить из-за своя связи между локальным сервером базы данных и координатором завершения транзакций.

Средняя

•	Завершено —  Накопленное число завершенных транзакций. Это число не включает принудительные (разрешенные вручную) завершения.

•	Прервано —  Накопленное число прерванных транзакций. Это число не включает принудительные прерывания.

•	Принуд. завершено —  Накопленное число вручную завершенных транзакций.

•	Принуд. прервано —  Накопленное число вручную прерванных транзакций.

•	Всего —  Накопленное число всех транзакций.

Время отклика

Эта группа отображает минимальное, среднее и максимальное время отклика транзакций в миллисекундах. Время отклика представляет собой время от начала транзакции до ее завершения.

MS DTC запущен/MS DTC остановлен

В данной группе отображается дата и время запуска текущего сеанса MS DTC. Они не будут отображаться, пока служба MS DTC не будет запущена. В группе показывается также, что служба MS DTC остановлена.

Некоторые характеристики являются накопительными; другие отражают текущее быстродействие.

При остановке службы MS DTC значения всех накопительных характеристик сбрасываются до нуля.

См. также

Управление MS DTC


Сообщения трассировки

Окно Сообщения трассировки содержит список текущих сообщений трассировки, выданных службой Microsoft Distributed Transaction Coordinator (MS DTC). Трассировка позволяет просматривать текущее состояние различных активностей MS DTC, например запуска и завершения, а также отслеживать потенциальные неполадки с помощью дополнительных отладочных сведений.

Обзор обработки транзакций содержится в следующих разделах:

•	Представление о транзакциях MTS

•	Представление о состояниях транзакций MTS

Окно Сообщения трассировки предназначено для выполнения следующих задач:

•	Наблюдение транзакций MTS

•	Наблюдение транзакций MTS под Windows 98

Имеется возможность использовать полозковый регулятор Трассировка на вкладке Дополнительно окна свойств компьютера для указания уровня сведений трассировки, отображаемых в данном окне.

Сложность

Значок	Описание
	Ошибки Иногда в таких случаях требуется перезапустить службу MS DTC. Например при повреждении файла журнала.
	Предупреждения Вскоре произойдет какой-либо сбой.
	Сведения Сведения о редких событиях, например запуске или завершении работы.
	Трассировка Отладочные сведения о таких событиях как подключение новых клиентов или диспетчера ресурсов.
Источник

Отображает источник сообщения трассировки:

•	SVC  —  служба MS DTC;

•	SVC  —  журнал MS DTC;

•	CM  —  диспетчер сетевого подключения службы MS DTC.

Трассировщик и журнал событий Windows NT сопровождают каждое событие его источником.

Сообщение

Отображает само сообщение.

См. также

Управление MS DTC


Значки транзакций

В окне Список транзакций отображаются следующие значки:

Значок	Описание
	Активна Транзакция была запущена.
	Прерывается Транзакция прерывается. MS DTC уведомляет всех участников, что транзакция должна быть прервана. В это время невозможно изменить исход транзакции.
	Прервана Транзакция прервана. Все участники были уведомлены. После того, как транзакция прервана, она немедленно удаляется из списка транзакций в окне транзакций MS DTC. В это время невозможно изменить исход транзакции.
	Готовится Клиентское приложение выдало запрос на завершение. MS DTC собирает запросы от всех участников.
	Готова Все участники ответили положительно на запрос о подготовке.
	Не определена Транзакция подготовлена, координируется другой службой MS DTC, и эта координирующая служба MS DTC недоступна. Системный администратор может вызвать завершение или прерывание транзакции, щелкнув правой кнопкой мыши в окне транзакций и выбрав команды Разрешить/Завершить или Разрешить/Прервать. После выбора исхода транзакция помечается как принудительно завершенная или принудительно прерванная. Внимание!  Не форсируйте вручную транзакции в неопределенном состоянии, пока не прочитаете раздел Разрешение транзакций MTS.
	Принуд. завершена Администратор форсировал завершение транзакции, находящейся в неопределенном состоянии (см. раздел Разрешение транзакций MTS).
	Принуд. прервана Администратор форсировал прерывание транзакции, находящейся в неопределенном состоянии (см. раздел Разрешение транзакций MTS).
	Завершается Транзакция успешно подготовлена, и MS DTC уведомляет участников о том, что транзакция была завершена. MS DTC не завершает транзакцию, пока все участники не подтвердят получение (и запись) запроса на завершение. В это время невозможно изменить исход транзакции.
	Сбой уведомления о прерывании MS DTC уведомил всех подключенных участников, что транзакция прервана. Не уведомлены только недоступные в данное время участники. Такое состояние транзакции возникает, когда MS DTC должен информировать какой-либо диспетчер ресурсов (например систему IBM LU 6.2), что транзакция прервана, но не может это выполнить, поскольку связь с системой IBM разорвана. Системный администратор может отложить транзакцию, щелкнув правой кнопкой мыши в окне транзакций и выбрав команды Разрешить/Отложить. Внимание!  Не форсируйте вручную транзакции, пока не прочитаете раздел Разрешение транзакций MTS.
	Сбой уведомления о завершении MS DTC уведомил всех подключенных участников, что транзакция завершена. Не уведомлены только недоступные в данное время участники. Системный администратор может отложить транзакцию, щелкнув правой кнопкой мыши в окне транзакций и выбрав команды Разрешить/Отложить. Внимание!  Не форсируйте вручную транзакции, пока не прочитаете раздел Разрешение транзакций MTS.
	Завершена Транзакция была завершена и все участники были уведомлены. После того, как транзакция завершается, она немедленно удаляется из списка транзакций в окне транзакций MS DTC.  В это время невозможно изменить исход транзакции.
См. также

Управление MS DTC


Свойства компьютера

Свойства компьютера определяют общие сведения о компьютере и управляют тем, как Microsoft Transaction Server обновляет компьютер.

Общие

Параметры

Дополнительно

См. также

Папка «Компьютеры»


Вкладка «Общие» (Компьютер)

Вкладка Общие отображает имя и описание компьютера.

Name

Отображает имя компьютера.

Описание

Отображает описание компьютера. Имеется возможность ввести описание, помогающее определить компьютер и управлять им.

См. также

Папка «Компьютеры»


Вкладка «Параметры» (Компьютер)

Вкладка Параметры используется для задания свойства времени ожидания транзакций и сведений о репликации компьютера.

Значение времени ожидания транзакций измеряется в секундах и указывает максимальный период времени, в течение которого запущенные на данном компьютере транзакции могут оставаться активными. Транзакции, которые остаются активными свыше указанного времени, автоматически прерываются системой. По умолчанию задается значение 60 секунд. Имеется возможность отключить время ожидания транзакций, указав значение 0; это особенно полезно при отладке приложений MTS.

Чтобы указать сведения о репликациях для компьютера MTS, воспользуйтесь разделом «Репликация» вкладки Параметры. В поле Общий ресурс репликации введите имя виртуального сервера Microsoft Cluster Server (MSCS) для обеспечения поддержки замены при сбоях (failover). Невозможна репликация каталога MTS на компьютере Windows 98.

Имеется также возможность указать компьютер, к которому должны иметь доступ исполняемые файлы клиента. Введите физическое имя сервера для доступа клиентов в поле Имя удаленного сервера перед созданием исполняемого файла приложения. Если оставить поле пустым, будет использоваться физическое имя экспортирующего компьютера. Если поместить в эту строку имя удаленного сервера, исполняемые файлы приложений, создаваемые MTS Explorer, будут указывать на это имя удаленного сервера.

См. также

Использование репликации MTS, Создание исполняемых файлов MTS, Папка «Компьютеры»


Вкладка «Дополнительно» (Компьютер)

Вкладка Дополнительно используется для настройки свойств службы Microsoft Distributed Transaction Coordinator (DTC). Эти параметры относятся только к окнам Список транзакций, Статистика транзакций и Сообщения трассировки.

Примечание. Невозможно получить доступ к справке со вкладки Дополнительно окна свойств компьютера «Мой компьютер».

Вид

•	Обновление экрана  —  меняется от Редкого до Частого с помощью полозкового регулятора. Редкое обновление экрана означает, что окна транзакций обновляются каждые 20 секунд, а Частое — каждую секунду. Более частые обновления увеличивают накладные расходы на администрирование при выполнении транзакций, но позволяют получить более точные сведения.

•	Вывод транзакций  —  меняется от Очень старых до Новых + старых с помощью полозкового регулятора. Выбор значения Очень старых приводит к отображению только транзакций. активных более 5 минут, а выбор значения Новых + старых приводит к отображению транзакций, активных 1 секунду и более.

•	Трассировка  —  меняется от < (быстрее MS DTC) до > (медленнее MS DTC) с помощью полозкового регулятора. Значения бывают следующие:

•	Без отправки трассировки.

•	Отправка только трассировки ошибок.

•	Отправка трассировки ошибок и предупреждений.

•	Отправка трассировки ошибок, предупреждений и сведений (используется по умолчанию).

•	Отправка всех трассировок.

Свойства журнала

•	Местоположение  —  где хранится файл журнала.

•	Емкость  —  максимальный размер файла журнала.

Сброс

Используется для обновления файла журнала после любых изменений.

Внимание!   Не сбрасывайте файл журнала MS DTC, пока имеются неразрешенные транзакции.

Обзор обработки транзакций содержится в следующих разделах:

•	Представление о транзакциях MTS

•	Представление о состояниях транзакций MTS

Использование окон Статистика транзакций, Сообщения трассировки и Список транзакций в окне Explorer описывается в следующих разделах:

•	Наблюдение транзакций MTS

•	Наблюдение транзакций MTS под Windows 98

См. также

Управление MS DTC


Свойства пакета

Свойства пакета определяют доступ к пакету.

Общие

Безопасность

Дополнительно

Удостоверение

Активизация

Важно!  Невозможно изменить свойства Безопасности или Удостоверения (либо завершить работу пакета) с помощью окна свойств для библиотечных пакетов.

На компьютерах Windows 98 окна свойств пакетов не включают вкладку Безопасность, поскольку основанная на ролях безопасность поддерживается только в системе Windows NT.

См. также

 Папка «Установленные пакеты»


Вкладка «Общие» (Пакет)

На вкладке Общие отображаются общие сведения о выбранном пакете.

Name

Отображает имя пакета.

Описание

Отображает описание данного пакета. Имеется возможность ввести описание, помогающее определить пакет и управлять им.

Код пакета

Отображает идентификационный номер пакета — уникальный номер, созданный при его создании. Его можно использовать для определения конкретных версий пакета на компьютере.

См. также

Папка «Установленные пакеты», Свойства пакета


Вкладка «Безопасность» (Пакет)

На вкладке Безопасность отображаются сведения о безопасности выбранного пакета.

Включить проверку прав доступа

Если этот флажок установлен, Microsoft Transaction Server проверяет учетные сведения любого клиента, вызывающего пакет. Проверка прав доступа по умолчанию включена.

Уровень проверки подлинности для вызовов

Уровень проверки подлинности для клиентов, вызывающих пакет.

См. также

Папка «Установленные пакеты», Свойства пакета, Задание уровней проверки подлинности MTS, Включение безопасности пакета MTS


Вкладка «Дополнительно» (Пакет)

Вкладка Дополнительно определяет, запущен ли серверный процесс, связанный с пакетом, либо он был завершен через определенное время.

Если требуется, чтобы при отсутствии активности пакет автоматически завершал работу через определенный период, можно воспользоваться параметром Завершить при отсутствии активности через, чтобы задать, когда серверный процесс должен завершить работу.

Если нужно, чтобы серверный процесс был всегда доступен, следует выбрать параметр Оставить процесс в состоянии ожидания.

Для завершения работы всех серверных процессов, работающих на выбранном компьютере, можно воспользоваться командой Завершить серверные процессы из меню Сервис.

См. также

Папка «Установленные пакеты»


Вкладка «Удостоверение» (Пакет)

Вкладка Удостоверение используется для задания удостоверения пользователя для всех компонентов, выполняющихся в данном пакете. По умолчанию это интерактивный пользователь, который в данное время вошел с систему с помощью своей учетной записи на сервере Windows NT. Если нужно задать другого пользователя, выберите параметр данного пользователя и укажите имя и пароль учетной записи.

Важно!  При задании удостоверения пакета MTS проверяет введенный пароль. Однако если для этой учетной записи пароль меняется без обновления пароля в MTS Explorer, пакет выполняться не будет. Если указать имя и пароль другого пользователя, Microsoft Transaction Server не проверяет пароль, при его задании. Запуск пакета с неправильным паролем приведет к ошибке выполнения и записи соответствующего сообщения в журнал событий.

Чтобы задать пользователя для параметра другого пользователя, необходимо войти в компьютер, назначенный для данного пользователя.

См. также

Настройка ролей MTS для декларативной безопасности, Папка «Установленные пакеты»


Вкладка «Активизация» (Пакет)

Вкладка Активизация используется для определения способа активизации компонентов в пакете.

Можно выбрать пакет, который будет выполняться в процессе клиента, который его вызвал (как библиотечный пакет), либо в выделенном локальном процессе (как серверный пакет).

Библиотечный пакет

Выберите данный параметр для выполнения пакета в качестве библиотечного. Библиотечный пакет выполняется в процессе клиента, который его создал. Этот параметр доступен только для клиентов на компьютерах, на которых пакет установлен и настроен. Следует отметить, что библиотечные пакеты не предлагают отслеживание компонентов, проверку ролей или изолированность процессов.

Серверный пакет

Выберите данный параметр для выполнения пакета в качестве серверного. Серверный пакет выполняется в своем собственном процессе на локальном компьютере. Серверные пакеты поддерживают безопасность на основе ролей, предоставление совместного доступа к ресурсам, изолированность процессов и управление процессами (например отслеживание пакетов).

См. также

Папка «Установленные пакеты», Свойства пакета


Свойства компонента

Свойства компонента управляют поддержкой транзакций и параметрами безопасности. Имеется также возможность воспользоваться вкладкой Свойства для просмотра идентификационных свойств компонента, например имени, программного идентификатора (ProgID), и идентификатора класса (CLSID).

Общие

Транзакции

Безопасность

См. также

Папка «Компоненты», Включение безопасности пакета MTS


Вкладка «Общие» (Компонент)

На вкладке Общие отображаются общие сведения о выбранном компоненте.

Код

Отображает программный идентификатор (ProgID).

Описание

Отображает описание компонента. Имеется возможность ввести описание, помогающее определить компонент и управлять им.

DLL

Отображает путь к библиотеке динамической компоновки (DLL), содержащей определения класса и интерфейса для данного компонента.

CLSID

Отображает идентификатор класса (CLSID) выбранного компонента. Имеется возможность использовать CLSID в программе для указания компонента и обращения к нему.

Пакет

Отображает имя пакета, в котором установлен выбранный компонент.

См. также

Папка «Компоненты», Свойства компонента


Вкладка «Безопасность» (Компонент)

Вкладка Безопасность используется для настройки безопасности выбранного компонента. Декларативная безопасность описывается в разделе Включение безопасности пакета MTS.

Включение проверки прав доступа

Если этот флажок установлен, Microsoft Transaction Server проверяет учетные сведения любого клиента, вызывающего пакет.

См. также

Папка «Компоненты», Свойства компонента MTS


Вкладка «Транзакции» (Компонент)

Вкладка Транзакции определяет поддержку транзакций компонента.

•	Требуется транзакция  —  Это указывает, что объекты компонента должны выполняться в транзакциях. При создании нового объекта его контекст наследует транзакцию из контекста клиента. Если клиент не имеет транзакции, MTS автоматически создает новую транзакцию для этого объекта.

•	Требуется новая транзакция  —  Это указывает, что объекты компонента должны выполняться в своих собственных транзакциях. При создании нового объект MTS автоматически создает для этого объекта новую транзакцию, независимо от того, имеет ли транзакцию его клиент.

•	Поддерживает транзакции  —  Это указывает, что объекты компонента могут выполняться в транзакциях своих клиентов. При создании нового объекта его контекст наследует транзакцию из контекста клиента. Если клиент не имеет транзакции, новый контекст также создается без транзакции.

•	Не поддерживает транзакции  —  Это указывает, что объекты компонента не должны выполняться в транзакциях. При создании нового объекта его контекст создается без транзакции, независимо от того, имеет ли транзакцию клиент.

См. также

Папка «Компоненты», Свойства компонента MTS, Управление транзакциями MTS


Свойства удаленного компонента

Свойства удаленного компонента используются для отображения сведений о компонентах, которые были добавлены в папку «Удаленные компоненты». Чтобы настроить свойства удаленного компонента, необходимо предоставить описание компонента на вкладке Общие.

Вкладка «Общие»

См. также

Папка «Удаленные компоненты», Распространение пакетов MTS


Вкладка «Общие» (Удаленный компонент)

На вкладке Общие отображаются идентификационные сведения о выбранном удаленном компоненте.

Имя

Отображает имя удаленного компонента.

Описание

Отображает описание удаленного компонента. Имеется возможность ввести описание, помогающее определить удаленный компонент и управлять им.

CLSID

Код класса для данного компонента.

Запуск на

Определяет имя компьютера, с которого был установлен данный компонент.

См. также

Папка «Удаленные компоненты»


Свойства роли

Свойства роли используются для просмотра имени, описания и идентификатора определенной роли.

Общие

См. также

Папка «Роли», Включение безопасности пакета MTS, Сопоставление ролей MTS с пользователями и группами


Вкладка «Общие» (Роль)

На вкладке Общие отображаются общие сведения о выбранной роли.

Имя

Отображает имя роли.

Описание

Отображает описание данной роли. Имеется возможность ввести описание, помогающее определить роль и управлять ей.

Код роли

Отображает идентификационный номер роли, создаваемый MTS при добавлении роли. Его можно использовать, чтобы различать роли с одинаковыми именами, определенные для разных пакетов.

Обзор объектов папки «Роли» и функций, выполняемых на уровне ролей, содержится в разделе Папка «Роли».

См. также

Папка «Роли», Свойства роли MTS, Включение безопасности пакета MTS, Сопоставление ролей MTS с пользователями и группами


Свойства обладателя роли

Свойства обладателя роли используются для отображения сведений о ролях, которые были добавлены для компонента или интерфейса.

Общие

См. также

Папка «Используемые роли», Включение безопасности пакета MTS, Сопоставление ролей MTS с пользователями и группами


Вкладка «Общие» (Обладатель роли)

На вкладке Общие отображаются общие сведения о выбранной роли.

Имя

Отображает имя роли.

Описание

Отображает описание данной роли. Имеется возможность ввести описание, помогающее определить роль и управлять ей.

Код роли

Отображает идентификационный номер роли, создаваемый MTS при добавлении роли. Его можно использовать, чтобы различать роли с одинаковыми именами, определенные для разных пакетов.

См. также

Папка «Используемые роли», Свойства роли, Включение безопасности пакета MTS, Сопоставление ролей MTS с пользователями и группами


Свойства интерфейса

Свойства интерфейса используются для отображения сведений о интерфейсе, используемом компонентом.

Общие

Proxy

См. также

Папка «Интерфейсы»


Вкладка «Общие» (Интерфейс)

На вкладке Общие отображаются идентификационные сведения о выбранном интерфейсе.

Имя

Отображает им интерфейса.

Описание

Отображает описание данного интерфейса. Имеется возможность ввести описание, помогающее определить интерфейс и управлять им.

IID

Отображает идентификатор интерфейса.

См. также

Папка «Интерфейсы», Свойства интерфейса


Вкладка «Proxy» (Интерфейс)

На вкладке отображаются о выбранном объекте proxy/stub.

Proxy/Stub

Отображает код CLSID и имя файла библиотеки (DLL) proxy/stub.

Библиотека типов

Отображает код библиотеки и размещение файла для библиотеки типов.

См. также

Папка «Интерфейсы», Свойства интерфейса


Свойства метода

Свойства метода используются для отображения сведений о методах, проявляемых интерфейсом.

Общие

См. также

Папка «Методы»


Вкладка «Общие» (Метод)

На вкладке Общие отображаются идентификационные сведения выбранного метода.

Имя

Отображается имя метода.

Описание

Отображается поле, в которое можно ввести описание метода.

См. также

Папка «Методы», Свойства метода


Создание пакетов MTS

Создание пакетов это конечный шаг в процессе разработки приложения MTS. Решения по структуре пакета определяются организацией и свойствами компонентов. Хотя создание пакетов MTS не требует знаний программирования, следует внимательно познакомиться со спецификациями структуры и применения приложения.

Рекомендуется прочитать данный раздел руководства администратора MTS вместе с руководством программиста MTS, чтобы понять на стадии разработки смысл упаковки компонентов с помощью Microsoft Transaction Server Explorer.

Упаковка компонентов предписывает для разработки решения, которые включают группирование ресурсов, активизацию параметров и поддержку транзакций. Например при создании пакета следует попробовать сгруппировать в одном пакете компоненты, совместно использующие одни и те же ресурсы. Рассмотрите типы ресурсов, компоненты которых совместно используются в вашем пакете, и сгруппируйте компоненты, которые совместно используют "дорогостоящие" ресурсы, такие как подключения к определенной базе данных.

Упаковка компонентов для использования преимуществ от группирования ресурсов позволяет более эффективно использовать приложения MTS. Если читать руководство программиста MTS вместе с руководством администратора MTS, можно получить больше сведений по вопросам разработки, которые определяют создание и распределение пакетов с помощью Explorer. Инструкции по получению руководства программиста MTS см. в разделе Установка примеров и документации для разработчика MTS.

В разделе обсуждаются следующие вопросы:

Создание пустого пакета MTS

Добавление компонента в пакет MTS

Импорт компонента в пакет MTS

Удаление компонента из пакета MTS

Сборка пакета MTS для экспорта

Задание свойств пакета MTS

Задание свойств активизации MTS

Задание свойств транзакций MTS

Здание уровней проверки подлинности MTS

Блокировка пакета MTS


Создание пустого пакета MTS

Чтобы начать использование MTS Explorer, необходимо создать пакет. Пакет, который легко создается в MTS Explorer, является семейством компонентов, которые выполняются в одном процессе. Нетрудно создать пустой пакет, а затем добавить компоненты, или установить готовый пакет. Добавьте пакеты с помощью мастера или перетаскивая файл пакета (.pak) из проводника Windows NT в правую область MTS Explorer.

Пакеты определяют границы для серверного процесса, выполняемого на компьютере сервера. Например, если поместить компоненты, отвечающие за продажи и покупки, в два разных пакета, то эти два компонента будут выполняться в отдельных изолированных процессах. Таким образом, если один из серверных процессов непредвиденно завершается (например в результате неустранимого сбоя приложения), другой пакет может продолжить выполнение в своем отдельном процессе.

Чтобы создать пустой пакет:

1	В левой области окна MTS Explorer выберите компьютер, для которого нужно создать пакет.

2	Откройте для этого компьютера папку «Установленные пакеты».

3	Выполните команду Создать из меню Действие. Имеется также возможность выбрать папку «Установленные пакеты», а затем щелкнуть ее правой кнопкой мыши и выполнить команды Создать и Пакет контекстного меню, либо нажать кнопку Создание нового объекта на панели инструментов MTS Explorer.

4	Воспользуйтесь мастером пакетов для установки готового пакета или для создания пустого пакета. Если создается пустой пакет, то чтобы начать работу с ним, необходимо добавить для него компоненты и роли.

5	Нажмите кнопку Создание пустого пакета.

6	Введите имя для нового пакета и нажмите кнопку Далее.

7	Укажите удостоверение пакета в диалоговом окне Задание удостоверения пакета, а затем нажмите кнопку Готово.

По умолчанию для удостоверения пакета используется запись интерактивного пользователя. Интерактивным пользователем является пользователь, вошедший в компьютер сервера, на котором выполняется данный пакет. Имеется возможность задать другого пользователя, выбирая параметр данного пользователя и указывая запись определенного пользователя Windows NT.

См. также

Добавление компонента в пакет MTS, Импорт компонента в пакет MTS, Сборка пакет MTS для экспорта, Включение безопасности пакета MTS


Добавление компонента в пакет MTS

Компонент MTS является многократно используемой частью программы и данных, построенной в соответствии со спецификацией модели COM (Component Object Model). Компоненты реализуют бизнес-логику приложения.

Компонент добавляется в пакет:

•	с помощью мастера компонентов;

•	перемещая компонент из существующего пакета.

Для добавления компонентов в соответствующую папку пакета, воспользуйтесь мастером компонентов MTS Explorer или перетащите библиотеки динамической компоновки (DLL), содержащие нужные компоненты, из проводника Windows NT в этот пакет. При использовании мастера имеется возможность установить новый компонент и добавить его в системный реестр или импортировать компоненты, которые уже были зарегистрированы. Компоненты могут добавляться как в пустые, так и в существующие пакеты.

Чтобы переместить компонент из существующего пакета, достаточно перетащить его из этого пакета в новый компонент.

Следует отметить, что одиночное приложение MTS может содержать компоненты, которые установлены в нескольких пакета. Имеется возможность поместить разные компоненты из одной и той же библиотеки динамической компоновки в абсолютно независимые пакеты.

Чтобы добавить компонент в пакет:

1	В левой области окна MTS Explorer выберите компьютер, на котором нужно установить компонент.

2	Откройте папку «Установленные пакеты» и выберите пакет, в который нужно установить компонент.

3	Откройте папку «Компоненты».

4	Выполните команду Создать из меню Действие. Имеется также возможность выбрать папку «Компоненты», а затем щелкнуть ее правой кнопкой мыши и выполнить команды Создать и Компонент контекстного меню, либо нажать кнопку Создание нового объекта на панели инструментов MTS Explorer.

5	Нажмите кнопку Установка новых компонентов.

6	В следующем диалоговом окне нажмите кнопку Добавить файлы для выбора устанавливаемых файлов. Выберите библиотеку (DLL), содержащую устанавливаемый компонент. Если компонент имеет внешнюю библиотеку типов или библиотеку proxy/stub, добавьте также эти файлы. Убедитесь, что в проводнике Windows NT установлен параметр отображения скрытых файлов. Если не задано отображение файлов с расширением dll, библиотеки динамической компоновки, содержащие компонент, не будут отображаться в диалоговом окне выбора файлов для установки. Необходимо перезапустить MTS Explorer после изменения значения этого параметра.

7	В следующем диалоговом окне выберите добавляемый файл или файлы и нажмите кнопку Открыть. Имеется возможность отобразить все доступные файлы, только файлы динамической компоновки (DLL), либо только библиотеки типов, выбирая соответствующее значение в поле Тип файлов.

8	После добавления файлов в диалоговом окне Установка компонентов отображаются файлы, которые были добавлены, и связанные с ними компоненты. Если установить флажок «Сведения», будет отображаться больше сведений о содержимом найденных файлов и компонентов. Компоненты Microsoft Transaction Server должны иметь библиотеку типов. Если MTS не удается найти библиотеку типов компонента, он не появится в списке. Имеется также возможность удалить файл из списка Устанавливаемые файлы, выбирая их и нажимая кнопку «Удалить файлы».

9	Для установки компонента нажмите кнопку Готово. Важно отметить, что установка компонента позволяет просмотреть интерфейсы и методы этого компонента. При импорте компонента его интерфейсы и методы недоступны для просмотра в окне MTS Explorer.

См. также

Создание пустого пакета MTS, Импорт компонента в пакет MTS, Удаление компонента из пакета MTS, Сборка пакета MTS для экспорта


Импорт компонента MTS в пакет

Имеется возможность использовать Microsoft Transaction Server Explorer для импорта в пакеты определенных компонентов, которые уже были зарегистрированы на компьютере как компоненты модели COM (Component Object Model). При импорте компонента не устанавливаются сведения о его интерфейсах или методах, необходимые для задания свойств интерфейса или для настройки доступа к компоненту с удаленного клиента. По возможности следует устанавливать, а не импортировать компоненты.

Чтобы импортировать компонент в пакет:

1	В левой области окна MTS Explorer выберите компьютер, в который нужно выполнить импорт компонента.

2	Откройте папку «Установленные пакеты» и выберите пакет, в который нужно импортировать компонент.

3	Откройте папку «Компоненты».

4	Выполните команду Создать из меню Действие. Имеется также возможность выбрать папку «Компоненты», а затем щелкнуть ее правой кнопкой мыши и выполнить команды Создать и Компонент контекстного меню, либо нажать кнопку Создание нового объекта на панели инструментов MTS Explorer.

5	Нажмите кнопку Импорт уже зарегистрированных компонентов.

6	Выберите нужные компоненты.

7	Нажмите кнопку Готово.

См. также

Создание пустого пакета MTS, Добавление компонента в пакет MTS


Удаление компонента MTS из пакета

Имеется возможность использовать Microsoft Transaction Server Explorer для удаления компонентов из пакета. Последствия удаления компонента зависят от того, как компонент был добавлен в среду выполнения MTS. Если компонент был установлен, его удаление полностью удаляет сведения реестра как из среды выполнения MTS, так и с компьютера. Если компонент был импортирован, он будет удален из среды выполнения MTS, но останется зарегистрированным на исходном компьютере как компонент модели COM (Component Object Model). Необходимо вручную удалить записи реестра для компонента COM, а также файлы компонента с исходного компьютера.

Чтобы удалить компонент из пакета:

1	В правой области окна Explorer выберите пакет, содержащий компонент, который нужно удалить.

2	Откройте папку «Компоненты».

3	Выберите нужный компонент.

4	Выполните команду Удалить из меню Действие. Имеется также возможность выбрать папку «Компоненты», а затем щелкнуть ее правой кнопкой мыши и выполнить команды Удалить контекстного меню, либо нажать кнопку Удалить на панели инструментов MTS Explorer.

5	Нажмите кнопку Да в следующем диалоговом окне.

См. также

Создание пустого пакета MTS


Сборка пакета MTS для экспорта

Для экспорта пакетов компоненты должны быть правильно настроены, чтобы MTS мог автоматически выполнить регистрацию пакета на компьютере сервера или клиента. При сборке пакета следует, таким образом, учесть, как он будет распространяться.

Имеется возможность для экспорта пакета на другой компьютер сервера, на котором работает MTS, использовать параметр экспорта в Microsoft Transaction Server Explorer. Имеется также возможность для доступа к серверному приложению создать исполняемые файлы приложения для удаленных клиентских компьютеров с системой Windows NT или Windows 98. Следует учитывать требования к экспорту пакетов при создании и настройке пакетов.

По умолчанию исполняемые файлы приложений настраивают клиентские компьютеры на доступ к удаленному серверу MTS, на котором эти файлы были созданы. Можно изменить размещение серверного приложения, настраивая вкладку Параметры окна свойств компьютера. Перед созданием исполняемого файла выберите Мой компьютер в окне MTS Explorer, щелкните его правой кнопкой мыши, а затем выполните команду Свойства контекстного меню. Выберите вкладку Параметры и введите имя компьютера сервера, к которому должен получить доступ компьютер клиента, в поле Имя удаленного сервера. Следует отметить, что вводимое имя компьютера должно соответствовать серверу MTS, на котором выполняется данный пакет. Затем нажмите кнопку OK. Создаваемый исполняемый файл клиента будет настраивать доступ клиента к серверу, указанному в поле Имя удаленного сервера. Это позволяет статически распределять загруженность приложения с помощью нескольких клиентских точек доступа к нескольким компьютерам, выполняющим один и тот же пакет.

Требования к экспорту пакета

Разработчики пакетов, системные администраторы или администраторы Web, развертывающие пакеты, должны учитывать следующие требования при сборке и установке пакетов MTS:

•	Чтобы определить номер версии компонента, программа установки клиента использует ресурс, который не зависит от языка. Для компонентов Visual C++  необходимо изменить номер версии приложения как зависимом, так и в независимом от языка ресурсе. Если не изменить зависимый от языка ресурс, исполняемый файл клиента может переписать более новую версию компонента на более старую.

•	Следует удалить описания стандартных интерфейсов COM из библиотек типов приложений, предназначенных только для клиентов. Например разработчик пакета определил интерфейс IObjectSafety в библиотеке типов, чтобы использовать этот интерфейс в Visual Basic. Удаление описаний интерфейса перед экспортом, предотвратит неправильные регистрацию и удаление регистрации этого интерфейса на компьютерах клиентах. Сбой удаления стандартных описаний интерфейса COM из библиотеки типов, предназначенной только для клиентов, может привести к сбою любого другого приложения, использующего эти стандартные интерфейсы.

•	Если какие-либо из глобальных уникальных идентификаторов (GUID) из серверного пакета (включая идентификаторы классов, интерфейсов или библиотек типов) изменяются клиентами, потребуется повторно экспортировать пакет, если нужно создать обновленный исполняемый файл установки клиента. Клиенты приложения не смогут получить доступ к серверному приложению, пока не запустят исполняемый файл установки нового клиента. Следует отметить, что некоторые средства разработки (такие как Microsoft® Visual Basic®) могут менять эти коды GUID без уведомления разработчика.

Дополнительные сведения об использовании MTS Explorer для распространения пакетов MTS содержатся в разделе Распространение пакетов MTS.

См. также

Создание пустого пакета MTS, Добавление компонента в пакет MTS, Импорт компонента в пакет MTS


Задание свойств пакета MTS

Свойства пакета определяют его конфигурацию. Чтобы получить доступ к окну свойств, щелкните пакет правой кнопкой мыши в окне Microsoft Transaction Server Explorer, либо выберите пакет и выполните команду Свойства из меню Действие.

Окно свойств пакета имеет пять вкладок:

•	Общие

На ней отображается имя и описание компьютера.

•	Безопасность

Включение проверки прав доступа. По умолчанию проверка прав доступа выключена. Дополнительные сведения содержатся в разделе Включение безопасности пакета MTS.

•	Дополнительно

Определяет, запущен ли серверный процесс, связанный с пакетом, либо он был завершен через определенное время.

•	Удостоверение

Используется для указания пользователя, которому разрешен доступ к пакету. По умолчанию это интерактивный пользователь, который в данное время вошел с систему с помощью своей учетной записи на сервере Windows NT. Если нужно задать другого пользователя, выберите параметр данного пользователя и укажите имя и пароль учетной записи.

•	Активизация

Используется для здания уровня активизации для пакета и его компонентов. Можно задать уровень активизации библиотечного пакета, при котором компоненты активизируются в процессе создателя, либо серверного пакета, когда пакет выполняется в выделенном серверном процессе.

Дополнительные сведения содержатся в разделе Задание свойств активизации MTS.

Чтобы изменить свойства пакета или компонента, необходимо воспользоваться окном свойств.

Чтобы открыть окно свойств:

1	Щелкните правой кнопкой мыши пакет или компонент, который нужно настроить и выполните команду Свойства. Имеется также возможность выбрать объект и выполнить команду Свойства из меню Действие.

2	Выберите нужную вкладку окна.

3	Измените значения свойств.

4	Чтобы сохранить значения параметров и вернуться в окно программы Explorer, нажмите кнопку OK.

Обновление параметров компонента

Важно обновлять значения параметров MTS для компонентов при каждой перекомпиляции проекта. Обновление параметров компонентов предотвращает перезапись параметров реестра компонента.

 Чтобы обновить значения параметров компонента:

1	В левой области окна MTS Explorer выберите компьютер, содержащий компоненты, которые нужно обновить.

2	Выполните команду Обновить все компоненты из меню Действие. Это приводит к обновлению Transaction Server для учета всех изменений системного реестра, кодов CLSID компонентов или идентификаторов интерфейсов (IID). Имеется также возможность для обновления компонентов выбрать компьютер в левой области окна Explorer и нажать кнопку Обновление на панели инструментов MTS.

Команда Обновить все компоненты выполняется в том случае, если выбран любой объект ниже компьютера в иерархической структуре MTS Explorer. Команда будет применяться к выбранному компьютеру.

См. также

Задание свойств активизации MTS, Задание свойств транзакций MTS, Задание уровней проверки подлинности MTS, Блокировка пакета MTS


Задание свойств активизации MTS

Свойства активизации следует определять во время разработки пакета. Можно сделать пакет, который будет выполняться в процессе клиента, который его вызвал (как библиотечный пакет), либо в выделенном серверном процессе (как серверный пакет).

Библиотечный пакет

Выберите данный параметр для выполнения пакета в качестве библиотечного. Библиотечный пакет выполняется в процессе клиента, который его создал. Этот параметр доступен только для клиентов на компьютерах, на которых пакет установлен и настроен. Следует отметить, что библиотечные пакеты не предлагают отслеживание компонентов, проверку ролей или изолированность процессов.

Серверный пакет

Выберите данный параметр для выполнения пакета в качестве серверного. Серверный пакет выполняется в своем собственном процессе на локальном компьютере. Серверные пакеты поддерживают безопасность на основе ролей, предоставление совместного доступа к ресурсам, изолированность процессов и управление процессами (например отслеживание пакетов).

Чтобы задать свойства активизации пакета:

1	Выберите требуемый для настройки пакет.

2	Выполните команду Свойства из меню Действие, а затем выберите вкладку Активизация. Можно также для открытия окна свойств выбрать объект, щелкнуть его правой кнопкой мыши и выполнить команду Свойства, либо нажать кнопку Свойства панели инструментов MTS.

3	Выберите вкладку Активизация и задайте нужное свойство.

4	Чтобы вернуться в окно Explorer, нажмите кнопку OK.

См. также

Задание свойств пакета MTS, Задание свойств транзакций MTS, Задание уровней проверки подлинности MTS, Блокировка пакета MTS


Задание свойств транзакций MTS

Следует определить, будет ли приложение поддерживать транзакции, во время его разработки, а затем использовать Microsoft Transaction Server Explorer во время развертывания для задания свойств транзакций компонента. Вкладка Транзакции окна свойств определяет, как компонент поддерживает транзакции. Имеется возможность выбрать один из следующих параметров свойств транзакций компонента:

•	Требуется транзакция. Это указывает, что объекты компонента должны выполняться в транзакциях. При создании нового объекта его контекст наследует транзакцию из контекста клиента. Если клиент не имеет транзакции, MTS автоматически создает новую транзакцию для этого объекта.

•	Требуется новая транзакция. Это указывает, что объекты компонента должны выполняться в своих собственных транзакциях. При создании нового объект Transaction Server автоматически создает для этого объекта новую транзакцию, независимо от того, имеет ли транзакцию его клиент.

•	Поддерживает транзакции. Это указывает, что объекты компонента могут выполняться в транзакциях своих клиентов. При создании нового объекта его контекст наследует транзакцию из контекста клиента. Если клиент не имеет транзакции, новый контекст также создается без транзакции.

•	Не поддерживает транзакции. Это указывает, что объекты компонента не должны выполняться в транзакциях. При создании нового объекта его контекст создается без транзакции, независимо от того, имеет ли транзакцию клиент.

Когда бы ни создавался экземпляр компонента, MTS проверяет атрибут транзакций компонента, чтобы определить, должен ли этот экземпляр выполняться в транзакции.

Не все компоненты предназначены для поддержки обработки транзакций. Если компонент не предназначен для использования обработки транзакций, убедитесь, что атрибут транзакций на вкладке Транзакции компонента имеет значение Не поддерживает транзакции.

Следует отметить, что невозможно изменить атрибуты транзакций компонентов пакета, которые были блокированы. Дополнительные сведения содержатся в разделе Блокировка пакета MTS.

Чтобы задать свойства транзакций компонента:

1	Выберите нужный компонент.

2	Выполните команду Свойства из меню Действие, а затем выберите вкладку Транзакции. Можно также для открытия окна свойств выбрать объект, щелкнуть его правой кнопкой мыши и выполнить команду Свойства, либо нажать кнопку Свойства панели инструментов MTS.

3	Щелкните нужное значение атрибута транзакций.

4	Нажмите кнопку ОК.

Обзор по распределенным транзакциям и инструкции по наблюдению за транзакциями и по управлению ими содержится в разделе Управление транзакциями MTS.

См. также

Задание свойств пакета MTS, Задание свойств активизации MTS, Задание уровней проверки подлинности MTS, Блокировка пакета MTS


Задание уровней проверки подлинности MTS

Уровень проверки подлинности приложения указывает уровень безопасности, использованный для проверки подлинности клиентских запросов. Если проверка подлинности не требуется для клиентов приложения, выберите Анонимный доступ на вкладке Безопасность окна свойств пакета. Если необходимо проверять подлинность клиентов, воспользуйтесь параметром Олицетворения. Серверный процесс установит указанный уровень проверки подлинности и его олицетворение, чтобы устранить влияние на него распределенной модели COM (DCOM).

Если не имеется полного понимания уровней проверки подлинности модели DCOM, желательно оставить уровень проверки подлинности пакета на используемом по умолчанию уровне MTS, который соответствует уровню «Пакет».

Следующая таблица описывает различные значения проверки подлинности модели DCOM:

Уровень	Описание
Отсутствует	Безопасность не проверяется при подключении данного пакета к другому пакету или клиентскому приложению.
Подключение	Проверка безопасности выполняется только при начальном подключении.
Вызов	Проверка безопасности происходит при каждом вызове в процессе сеанса связи.
Пакет	Удостоверение отправителя шифруется .
Целостность пакета	Удостоверение и подпись отправителя шифруются для гарантии неискаженной передачи пакетов.
Конфиденциальность пакета	Весь пакет, включая данные, а также удостоверение и подпись пакета, шифруется для обеспечения наибольшей безопасности.
Чтобы задать уровни проверки подлинности для компьютера:

1	Выберите настраиваемый пакет в окне MTS Explorer.

2	Выполните команду Свойства из меню Действие, а затем выберите вкладку Безопасность. Можно также для открытия окна свойств выбрать объект, щелкнуть его правой кнопкой мыши и выполнить команду Свойства, либо нажать кнопку Свойства панели инструментов MTS.

3	Выберите нужный уровень проверки подлинности для пакета в группе списке «Уровень проверки подлинности для вызовов».

4	Нажмите кнопку ОК.

См. также

Задание свойств пакета MTS, Задание свойств активизации MTS, Задание свойств транзакций MTS, Блокировка пакета MTS


Блокировка пакета MTS

После разработки, установки или развертывания приложения может потребоваться блокировать пакет, чтобы предотвратить изменения конфигурации компонентов. Имеется возможность блокировать пакет до экспорта серверного приложения на другой компьютер MTS, обслуживаемый системным администратором или Web-администратором, либо до предоставления серверного приложения клиентам.

Допускается блокировка пакета от:

•	изменений

При этом администраторы не смогут изменить конфигурацию пакета без отключения блокировки.

•	удалений

При этом администраторы не смогут удалить пакета без отключения блокировки.

Чтобы блокировать пакет:

1	После завершения настройки пакета выберите вкладку Дополнительно в окне свойств пакета.

2	В разделе «Разрешения» вкладки установите флажок Отключить удаление (после этого пользователям запрещается удалять пакет) или Отключить изменения (после этого блокируются любые изменения пользователями свойств пакета).

Для разблокирования пакета снимите флажки на вкладке Дополнительно окна свойств.

См. также

Задание свойств пакета MTS, Задание свойств активизации MTS, Задание свойств транзакций MTS, Задание уровней проверки подлинности MTS


Распространение пакетов MTS

Имеется возможность использовать Microsoft Transaction Server Explorer для распространения пакетов клиентам с работающим MTS, а также  клиентам, не имеющим MTS. Если и на компьютере клиента, и на компьютере сервера запущен MTS, имеется возможность использовать MTS Explorer для создания исполняемых файлов приложений, либо для передачи и получения компонентов с помощью папки «Удаленные компоненты». Если компьютер клиента не имеет MTS, используйте MTS Explorer для создания исполняемых файлов приложений, которые автоматически установят и настроят клиентов для доступа к удаленному серверному приложению MTS с помощью стандарта распределенной модели COM (DCOM).

В разделе обсуждаются следующие вопросы:

Работа с удаленными компьютерами MTS

Экспорт пакетов MTS

Создание исполняемых файлов MTS

См. также

Папка «Удаленные компоненты» MTS


Работа с удаленными компьютерами MTS

Если и на компьютере сервера, и на компьютере клиента работает MTS, имеется возможность распространять пакет передавая компоненты в пределах одного или между несколькими компьютерами. Имеется также возможность создавать файлы с помощью служебной программы для исполняемых файлов приложений в окне Microsoft Transaction Server Explorer. Дополнительные сведения об использовании MTS Explorer для создания исполняемых файлов приложений содержатся в разделе Создание исполняемых файлов MTS.

Передача компонентов означает создание записей для удаленных компонентов на удаленных компьютерах. После создания элементов удаленного компонента, необходимо добавить эти элементы в папку «Удаленные компоненты» на локальном компьютере (перенесите в нее компоненты).

На следующем рисунке показано как перенос компонентов настраивает удаленных компьютер с MTS.

На рисунке MTS установлен на трех компьютерах. GetReceipt и MoveMoney оба установлены в пакет на вашем компьютере (сервер A). При добавлении компонентов GetReceipt и MoveMoney в папки «Удаленные компоненты» сервера B и сервера C происходят две вещи. Сначала файлы нужных библиотек динамической компоновки (DLL) копируются через сеть на сервер B и сервер C. Эти файлы будут скопированы в подкаталог с тем же именем, как и для пакета на сервере A. Этот подкаталог будет создан в каталоге \<Каталог установки Microsoft Transaction Server>\Remote (например C:\Program Files\MTx\Remote\Sample Bank). Затем, системные реестры сервера B и сервера C обновляются сведениями из системного реестра сервера A.

Имеется возможность передавать и получать компоненты, только если для хранения и доставки файлов библиотек динамической компоновки и библиотек типов был задан общий сетевой каталог. (Имеется возможность выбрать любой общий сетевой каталог с файлами компонентов, содержащимися в папках или вложенных папках этого общего каталога.) MTS Explorer автоматически найдет доступные общие сетевые каталоги на сервере. На данном сервере имеется возможность иметь несколько общих папок для доступа к разным наборам файлов компонентов.

Кроме того, необходимо убедиться, что:

•	вход в систему выполнен с помощью учетной записи Windows NT, являющейся участником роли Administrators пакета System на конечном компьютере;

•	удостоверение пакета System конечного компьютера сопоставлено с учетной записью NT, которая входит в роль Reader (Читатель) пакета System;

•	безопасность включена для пакета System на обоих компьютерах. Дополнительные сведения содержатся в разделе Включение безопасности пакета MTS.

Для передачи компонентов необходимо сначала добавить нужный компьютер или компьютеры в MTS Explorer, а затем добавить свои компоненты в папку «Удаленные компоненты» для удаленного компьютера. Дополнительные сведения о добавлении компьютера в окно Explorer содержатся в разделе Настройка сервера MTS.

Затем необходимо добавить компоненты в папку «Удаленные компоненты» для удаленного компьютера.

Чтобы добавить компоненты в папку «Удаленные компоненты» удаленного компьютера:

1	Добавьте удаленный компьютер, выбирая папку «Компьютеры» и выполняя команду Создать из меню Действие.

2	Введите имя для добавляемого компьютера и нажмите кнопку ОК. Если имя неизвестно, выясните его, нажав кнопку Обзор.

3	Откройте в окне MTS Explorer папку «Удаленные компоненты» компьютера, к которому нужно добавить удаленные компоненты.

4	Выполните команду Создать из меню Действие. Можно также щелкнуть правую кнопку мыши и выполнить из контекстного меню команду Создать, а затем команду Компонент.

5	В открывающемся диалоговом окне выберите удаленный компьютер и пакет, которые содержат нужный для удаленного вызова компонент.

6	В списке Доступные компоненты выберите компонент для удаленного вызова и нажмите кнопку со стрелкой вниз (Добавить). При этом компонент и содержащий его компьютер добавляются в поле Компоненты для настройки на. Если установить флажок Сведения, отображаются удаленный компьютер, пакет и путь к библиотекам динамической компоновки (DLL) отображаются в поле Компоненты для настройки на.

7	Нажмите кнопку ОК.

Примечание.   При добавлении компонентов, хранящихся на удаленном компьютере, требуемые файлы сохранятся в каталоге \каталог установки\remote. (По умолчанию MTS устанавливается в каталог \Program Files\MTS.)

См. также

Папка «Удаленные компоненты» MTS


Экспорт пакетов MTS

Экспорт пакетов позволяет копировать пакет с одного компьютера MTS на другой. Например с помощью Microsoft Transaction Server Explorer можно экспортировать пакет с сервера, на котором он был разработан, на другой сервер MTS для проверки.

Чтобы выполнить экспорт пакета:

1	Выберите пакет для экспорта в левой области окна Explorer.

2	Выполните команду Экспорт из меню Действие. Можно также щелкнуть правую кнопку мыши и выполнить команду Экспорт контекстного меню.

3	Введите или найдите файл создаваемого пакета в диалоговом окне Экспорт пакета. Файлы компонентов будут скопированы в тот же каталог, что и файл пакета.

4	Если нужно включить какие-либо роли, которые были заданы для пакета, установите флажок Сохранить коды пользователей Windows NT, связанные с ролями.

5	Нажмите кнопку Экспорт.

При экспорте пакета Microsoft Transaction Server создает файл пакета (с расширением .pak), содержащий сведения о компонентах и ролях (если есть), включенных в исходный пакет, и копирует файлы связанных компонентов (библиотеки динамической компоновки (DLL), библиотеки типов и все библиотеки объектов proxy/stub) в тот же каталог, в котором был создан файл пакета. Копируются только библиотеки динамической компоновки (DLL) компонентов. Блокировки изменений и удалений пакета экспортируются вместе с пакетом.

Важно!  Если код класса (CLSID) компонента, идентификатор библиотеки типов (TypeLibId) или идентификатор интерфейса (IID) изменяются после экспорта пакета, необходимо вновь экспортировать пакет.

См. также

Сборка пакета MTS для экспорта, Блокировка пакета MTS, Сопоставление ролей MTS с пользователями и группами


Создание исполняемых файлов MTS

С помощью MTS Explorer можно создавать исполняемые файлы приложений, которые устанавливают и настраивают компьютер клиента для доступа к удаленному приложению-серверу. Компьютер клиента, который устанавливает исполняемый файл, должен иметь поддержку распределенной модели COM (DCOM), и для доступа к удаленному приложению-серверу не требуются никакие другие файлы сервера MTS, кроме самого исполняемого файла.

Служебная программа для исполняемых файлов приложений является частью операции экспорта пакетов в окне MTS Explorer. Эта служебная программа позволяет автоматически создавать исполняемые файлы приложений, которые устанавливают клиентские приложения и настраивают компьютер клиента для доступа к приложению-серверу на удаленных серверах MTS. Исполняемые файлы, созданные этой служебной программой, по умолчанию настраивают компьютер клиента для доступа к исходному серверу, на котором был создан исполняемый файл.

Имеется также возможность настроить поле Имя удаленного сервера на вкладке Параметры окна свойств компьютера, чтобы указать клиентским приложениям сервер, отличный от исходного. Если имя другого сервера не указано перед экспортом пакета для создания исполняемого файла, исполняемые файлы приложений, созданные на локальном компьютере, будут автоматически настраивать компьютеры клиентов для доступа к серверным пакетам на данном локальном компьютере.

Чтобы настроить исполняемый файл приложения клиента для доступа к серверному компьютеру, отличному от локального:

1	Выберите папку Мой компьютер.

2	Щелкните правую кнопку мыши и выполните команду Свойства контекстного меню.

3	Выберите вкладку Параметры и введите имя удаленного сервера в поле Имя удаленного сервера в группе «Репликация».

4	Нажмите кнопку OK и выполните экспорт пакета для создания исполняемого файла приложения.

Служебная программа для исполняемых файлов приложений автоматически создает исполняемый файл для клиентского приложения.

На клиенте исполняемый файл автоматически выполняет следующие шаги:

1.	Копирует временный каталог на компьютер клиента или сервера, а затем распаковывает необходимые на стороне клиента файлы, включая библиотеки типов и специальные custom библиотеки объектов proxy-stub.

2.	Передает библиотеки типов и объектов proxy-stub для приложения-сервера в каталог «Удаленные приложения» в подкаталоге \Program Files. Все удаленные приложения сохраняются в каталоге «Удаленные приложения». Каждое удаленное приложение имеет отдельный каталог с именем, соответствующим глобальному уникальному идентификатору пакета (GUID).

3.	Обновляет системный реестр с записями, которые позволяют клиентам использовать серверное приложение с удаленным доступом (включая сведения, относящиеся к приложению, классам, программированию, интерфейсу и идентификаторам библиотек), либо позволяют серверному приложению выполняться на компьютере сервера.

4.	Регистрирует приложение, чтобы пользователь смог позже удалить его с помощью значка Установка и удаление программ панели управления. Все удаленные приложения начинаются со строки «Удаленное приложение», чтобы их легче было найти в списке установленных компонентов.

5.	Удаляет файлы во временном каталоге, созданные во время установки приложения.

При запуске на компьютера клиента исполняемый файл клиента копирует необходимые библиотеки объектов proxy-stub и библиотеки типов на этот компьютер и обновляет системный реестр клиента со сведениями, необходимыми модели DCOM, включая имя компьютера сервера. Таким образом, клиентское приложение получает доступ к удаленному приложению-серверу.

Чтобы создать исполняемый файл клиента:

1	Установите приложение-сервер с помощью мастера пакетов, если это еще не было сделано.

2	Выполните экспорт пакета и укажите новое имя файла (ИмяНовогоФайла) в качестве имени файла для экспортируемого пакета. (Чтобы предоставить клиентам доступ к серверу, отличному от сервера развертывания, необходимо настроить поле Имя удаленного сервера на вкладке Параметры окна свойств компьютера.) .

3	Найдите папку, в которую был экспортирован пакет. При экспорте в MTS Explorer существующего пакета в каталоге, в который экспортируется пакет, создается вложенная папка «Clients». Вложенная папка Clients содержит единственный исполняемый файл с именем, заданным при экспорте пакета. При запуске на любом клиенте, поддерживающем модель DCOM, этот исполняемый файл устанавливает все необходимые сведения для доступа удаленных клиентов к приложению-серверу.

Важно!   Не запускайте исполняемый файл клиента на компьютере сервера. Запуск исполняемого файла клиента на компьютере сервера удаляет записи реестра, необходимые для запуска серверного пакета. Если это выполнено по ошибке, необходимо удалить данное приложение с помощью значка Установка и удаление программ панели управления. Затем удалите и переустановите пакет с помощью окна MTS Explorer.

Если другая версия компонента, установленная исполняемым файлом клиента, уже существует на клиентском компьютере, компонент будет обновлен, только если:

•	обе версии компонента имеют номера;

•	версия устанавливаемого компонента превосходит версию уже установленного не клиентском компьютере компонента.

Чтобы настроить установку клиентского приложения для включения дополнительных файлов, создайте файл установки с именем clients.ini в подкаталоге Clients. Файл clients.ini может быть изменен для объединения установки исполняемых файлов клиента для нескольких разных приложений или для включения документации приложения.

Чтобы настроить установку:

1	Создайте файл .ini с именем clients.ini и сохраните его в папке, в которую будет экспортирован пакет.

2	Скопируйте следующий текст в пустой файл clients.ini.

[ClientApplicationFiles]

SourcePath=c:\temp\custom vb bank

[ClientApplicationInstallCommands]

1=notepad {{{readme.txt}}}

2={{{vbbank.exe}}}

[ClientApplicationSetup]

ExploreApplication=Y

3	Под заголовком «Client Application Files» измените путь на путь к каталогу, в который нужно установить исходные программы на клиентском компьютере. Например,

Source Path=c:\program files\mts\test\vb bank

4	Под заголовком ClientApplicationInstallCommands введите имена устанавливаемых файлов. Воспользуйтесь тройными скобками для имен устанавливаемых файлов. Например,

1=notepad {{{readme.txt}}}
2={{{vbbank.ex}}}}

Следует отметить, что устанавливаемые файлы должны находиться в каталоге, указанном в "Source Path".

1	Под заголовком ClientApplicationSetup укажите, требуется ли включить параметр установки ExploreApplication. Например следующая запись будет приводить к немедленному отображению приложения после установки, чтобы клиент смог создать ярлык на рабочем столе:

ExploreApplication=Y

После сохранения этих изменений в файле clients.ini выполните с помощью MTS Explorer экспорт серверного пакета для создания исполняемого файла клиента.

Чтобы создать исполняемый файл клиента:

1	Установите приложение-сервер с помощью мастера пакетов, если это еще не было сделано.

2	Создайте папку, в которую хотите экспортировать пакет.

3	Выполните экспорт пакета с сервера, на котором установлено приложение-сервер, на другой сервер. (Чтобы предоставить клиентам доступ к серверу, отличному от сервера развертывания, необходимо настроить поле Имя удаленного сервера на вкладке Параметры окна свойств компьютера.) Укажите новое имя файла (ИмяНовогоФайла) в качестве имени файла для экспортируемого пакета.

4	Найдите папку, в которую был экспортирован пакет. При экспорте в MTS Explorer существующего пакета в каталоге, в который экспортируется пакет, создается вложенная папка «Clients». Вложенная папка Clients содержит единственный исполняемый файл с именем, заданным при экспорте пакета. При запуске на любом клиенте, поддерживающем модель DCOM, этот исполняемый файл устанавливает все необходимые сведения для доступа удаленных клиентов к приложению-серверу.

Важно!   Не запускайте исполняемый файл клиента на компьютере сервера. Запуск исполняемого файла клиента на компьютере сервера удаляет записи реестра, необходимые для запуска серверного пакета. Если это выполнено по ошибке, необходимо удалить данное приложение с помощью значка Установка и удаление программ панели управления. Затем удалите и переустановите пакет с помощью окна MTS Explorer.

Если другая версия компонента, установленная исполняемым файлом клиента, уже существует на клиентском компьютере, компонент будет обновлен, только если:

•	обе версии компонента имеют номера;

•	версия устанавливаемого компонента превосходит версию уже установленного не клиентском компьютере компонента.

Распространение исполняемого файла клиента

MTS Explorer автоматизирует упаковку и установку клиентских приложений с помощью исполняемых файлов для распространения. Для распространения этих файлов используются следующие методы:

•	Предоставление совместного доступа к каталогу, чтобы клиенты могли скопировать исполняемый файл и запустить его на своих компьютерах.

•	Отправка исполняемого файла в виде вложения по электронной почте, чтобы клиенты смогли сохранить и запустить его на своих компьютерах.

•	Включение исполняемого файла в сценарий HTML с помощью тэга <OBJECT>. Тэг <OBJECT> позволяет средству просмотра загрузить приложение из указанного хранилища объектов на компьютер клиента, если клиент инициирует событие на странице HTML (например нажимает кнопку). Использование тэга <OBJECT> для распространения исполняемых файлов облегчает их обновление, поскольку средство просмотра автоматически проверяет в реестре клиента текущую версию приложения. Если исполняемый файл устарел, средство просмотра загружает последнюю версию из хранилища объектов.

•	Воспользуйтесь Microsoft System Management Server (SMS) для передачи дистрибутива приложения из единого центра сразу на десятки или сотни компьютеров. Следует отметить, что после установки приложения на удаленных компьютерах необходимо установить само клиентское приложение.

Удаление исполняемого файла клиента

Клиенты могут удалить исполняемый файл с помощью параметра Добавить/удалить панели управления. Приложения, установленные исполняемыми файлами MTS, начинаются со строки «Удаленное приложение» в списке приложений для установки/удаления. Чтобы удалить исполняемый файл, выберите нужное приложение и нажмите кнопку Удалить.

См. также

Экспорт пакетов MTS, Сборка пакета MTS для экспорта


Установка пакетов MTS

Установка пакетов MTS состоит из установки и развертывания пакетов в среде выполнения MTS с помощью MTS Explorer. Процедуры установки и развертывания тесно связаны с вопросами структуры, например с заданием нужного пакету удостоверения.

При развертывании приложений убедитесь, необходимо хорошо представлять себе структуру пакета и его компонентов. Дополнительные сведения о разработке и сборке компонентов MTS содержатся в руководстве программиста MTS.

С помощью MTS Explorer имеется возможность развернуть готовые пакеты. В разделе обсуждаются следующие вопросы:

Установка готовых пакетов MTS

Обновление пакетов MTS

Включение безопасности пакета MTS

Задание удостоверения пакета MTS

Добавление новой роли MTS

Сопоставление ролей MTS с пользователями и группами

См. также

Вкладка «Удостоверение» (Пакет), Папка «Установленные пакеты», Папка «Роли», Папка «Пользователи», Папка «Используемые роли», Выбор пользователей для ролей MTS


Установка готовых пакетов MTS

Готовые пакеты состоят из файла пакета и файлов компонентов (.dll и .tlb), связанных с пакетом. С помощью MTS Explorer установите и разверните готовые пакеты, разработанные независимыми разработчиками или разработчиками организации.

Следует отметить, что после установки любого пакета, минимальная настройка пакета включает управление доступом к объектам, сохраняемым MTS, сопоставление пользователей с ролями и задание уровней безопасности для пакетов. Дополнительные сведения о настройке безопасности для пакета содержатся в разделе Включение безопасности пакета MTS.

Чтобы установить готовый пакет:

1	В левой области окна MTS Explorer выберите компьютер, на котором нужно создать пакет.

2	Откройте для этого компьютера папку Установленные пакеты.

3	Выполните команду Создать из меню Действие. Имеется также возможность нажать кнопку Создание нового объекта на панели инструментов MTS Explorer, либо щелкнуть правую кнопку мыши в папке Установленные пакеты и последовательно выполнить команды Создать и Пакет.

4	Нажмите кнопку Установка готовых пакетов.

5	В диалоговом окне Выбор файлов пакета нажмите кнопку Добавить, чтобы найти доступные файлы пакетов в сети. Выберите файл пакета (.pak), нажмите кнопку Открыть, а затем кнопку Далее. Можно установить несколько пакетов одновременно. Файлы компонентов, входящих в пакет, должны размещаться в том же каталоге, что и файл пакета.

6	Укажите удостоверение пакета в диалоговом окне Задание удостоверения пакета, а затем нажмите кнопку Далее. По умолчанию для удостоверения пакета используется запись интерактивного пользователя. Интерактивный пользователь - это пользователь, вошедший в компьютер с помощью учетной записи Windows NT и запустивший пакет. Имеется возможность задать другого пользователя, выбирая параметр данного пользователя и указывая запись определенного пользователя Windows NT.

7	В поле параметров установки укажите каталог для установки. Файлы компонентов копируются из каталога файла пакета в каталог для установки. Имеется возможность воспользоваться используемым по умолчанию каталогом, либо нажать кнопку Обзор для выбора другого каталога.

8	Если устанавливаемый файл пакета содержит определенных пользователей Windows NT, будет доступен параметр Добавить пользователей Windows NT из файла пакета. Установка флажка добавляет этих пользователей к новому пакету.

9	Нажмите кнопку Готово. Структура окна Explorer отображает новый пакет в области справа. При установке нескольких пакетов выбираемые на шаге 6 и 7 параметры применяются ко всем пакетам.

В системе Windows NT имеется также возможность установить готовый пакет, перетаскивая файл пакета из Windows NT Explorer в правую область окна MTS Explorer при открытой папке Пакеты компьютера.

См. также

Папка «Установленные пакеты»


Обновление пакетов MTS

Если нужно обновить пакет MTS, необходимо сначала удалить его предыдущие версии, а затем установить обновленный пакет.

Чтобы удалить пакет:

1	В левой области окна MTS Explorer выберите компьютер, для которого нужно удалить пакет.

2	Откройте папку Установленные пакеты для указанного компьютера, чтобы отобразить все пакеты.

3	Выберите удаляемый пакет.

4	Выполните команду Удалить из меню Действие. Можно также щелкнуть правую кнопку мыши и выполнить команду Удалить контекстного меню.

5	Для удаления пакета нажмите кнопку Да.

При удалении пакета удаляются также все компоненты, входящие в пакет. Имеется также возможность удалить пакет, выбрав его и нажав кнопку DELETE.

Дополнительные инструкции по установке обновленного пакета содержатся в разделе  Установка готовых пакетов MT.

См. также

Папка «Установленные пакеты»


Включение безопасности пакета MTS

MTS предлагает два типа безопасности пакетов:

•	программная безопасность

Обеспечивает интерфейсы, которые можно использовать для создания безопасности логики приложения. Дополнительные сведения об использовании программной безопасности содержатся в руководстве программиста MTS.

•	декларативная безопасность

Позволяет определять роли и сопоставлять пользователей и группы Windows NT с ролями  помощью окна MTS Explorer.

Важно. Библиотечные пакеты не поддерживают проверку ролей. Чтобы включить безопасность, необходимо изменить параметры активизации на серверный пакет. Дополнительные сведения о библиотечных и серверных пакетах содержатся в разделе  Задание свойств активизации MTS.

Администраторы используют для защиты пакетов декларативную безопасность, гарантируя, что только клиенты с нужными привилегиями доступа смогут запускать пакет. Доступ предоставляется в окне MTS Explorer с помощью ролей MTS и на основе учетных записей пользователей и групп Windows NT. Следует отметить, что, поскольку декларативная безопасность, использует для проверки аутентичности учетные записи Windows NT, невозможно использовать декларативную безопасность для пакета, запускаемого на компьютере Windows 98.

Чтобы задать декларативную безопасность для пакета, выполните следующие шаги:

1.	Определите роли на уровне пакета с помощью диалогового окна Создание роли.

Описание добавления новой роли содержится в разделе  Добавление новой роли MTS.

1.	Сопоставьте пользователей с ролями с помощью диалогового окна Добавление пользователей и групп для роли. Следует отметить, что пакет, у которого отсутствуют пользователи для всех ролей, не может быть вызван.

Сведения о том, как добавить пользователей и группы к роли, содержатся в разделе Сопоставление ролей MTS с пользователями и группами.

1.	Присвойте определенную роль папке «Используемые роли» компонента или интерфейса, если нужно ограничить доступ к определенному компоненту или интерфейсу.

2.	Включите безопасность пакета на вкладке Безопасность окна свойств пакета. Данный раздел содержит описание способа включения проверки прав доступа.

Если не сопоставить используемую в данное время учетную запись пользователя с ролью администратора перед включением безопасности пакета System, будет получен отказ в доступе к функциям MTS Explorer, которые изменяют настройку (например добавляют пользователей к роли). Если это произошло, необходимо войти в систему в качестве пользователя, который был сопоставлен с ролью Administrator. Чтобы защитить администраторов от разблокирования пакета System, MTS Explorer отображает сообщение об ошибке при попытке:

•	включить безопасность для пакета System, когда ни один пользователь не сопоставлен с ролью администратора;

•	удалить последнего пользователя из роли администратора, когда безопасность для пакета System включена.

Примечание. Если MTS установлен на сервере, играющем роль основного или резервного контроллера домена, то, чтобы управлять пакетами в MTS Explorer, пользователь должен быть администратором домена.

Если не включить безопасность для пакета, то роли для компонента или интерфейса не будут проверяться MTS. Кроме того, если безопасность не включена для компонента, MTS не будет проверять роли для интерфейса компонента.

Описание добавления роли к папке «Используемые роли» содержится в разделе  Добавление новой роли MTS.

Примечание.  Отключение декларативной безопасности для отдельных компонентов или пакета полезно при отладке пакета.

Рассмотрим задание ограничений доступа к серверному пакету для описи. Системному администратору необходимо ограничить доступ к пакету описи для сотрудников из отдела продаж. Для этого сначала выберите папку «Роль» для пакета описи, выполните команду Создать из меню Действие и введите «Sales» в качестве имени новой роли. Затем выберите папку «Пользователи», выполните команду Создать из меню Действие и введите имя учетной записи группы Windows NT для отдела продаж. Добавьте роль «Sales» в папку «Используемые роли» для каждого компонента. Теперь только сотрудникам отдела продаж разрешен доступ к пакету описи. Наконец, выберите пакет, перейдите на вкладку Безопасность окна свойств и установите флажок Включить проверку прав доступа, чтобы включить новые параметры безопасности для пакета.

Если требуется ограничить доступ к определенному компоненту внутри пакета, необходимо понимать, как компоненты пакета вызывают друг друга. Если компонент напрямую вызывается базовым клиентом, MTS будет проверять роли и для этого компонента. Если один компонент вызывает другой компонент из того же пакета, MTS не проверяет поли, поскольку подразумевается, что компоненты внутри одного пакета «доверяют» друг другу.

Предположим, необходимо настроить роли, чтобы разрешить клиенту вызывать компонент CheckInventory и запретить для клиента прямой вызов компонента Backorder. Оба компонента CheckInventory и Backorder находятся в пакете Inventory. Сначала необходимо задать роль клиента для компонента CheckInventory. Затем убедимся, что компонент Backorder не имеет ролей, сопоставленных с удостоверением клиента. Поскольку компоненты CheckInventory и Backorder содержатся в одном пакете, проверка ролей не выполняется, когда компонент CheckInventory вызывает компонент Backorder.

Тем не менее компонент CheckInventory может вызывать компонент Backorder от имени клиента, если выполнены следующие условия:

•	удостоверение клиента сопоставлено с нужной ролью CheckInventory;

•	удовлетворены все требования программной безопасности.

Это позволяет создавать пакеты, содержащие взаимно доверенные компоненты, и ограничивая доступ к выделенным компонентам.

Чтобы задать проверку ролей для  исходных вызывающих клиентов, которые непосредственно вызывают компонент Backorder, выберите папку «Используемые роли» для компонента Backorder, выполните команду Создать из меню Действие и выберите роль Sales. Теперь, когда роль Sales (с сопоставленными пользователями) присвоена компоненту Backorder, только сотрудники отдела продаж смогут запускать компонент Backorder для просмотра небиржевых объектов. Чтобы активизировать новые параметры безопасности, установите флажок Включить проверку прав доступа для пакета Inventory, как и для компонента Backorder.

Дополнительные сведения о проверке ролей содержатся в разделе Программная безопасность руководства программиста MTS.

Чтобы разрешить проверку прав доступа для обеспечения безопасности:

1	Сопоставьте свою учетную запись пользователя с ролью Administrator пакета System, если это еще не было сделано.

2	Выберите пакет System и выполните команду Свойства из меню Действие или из контекстного меню (вызывается щелчком правой кнопки мыши).

3	Перейдите на вкладку Безопасность и установите флажок Включить проверку прав доступа.

4	Остановите серверный процесс пакета System Package, выбрав его, щелкнув правую кнопку мыши и выполнив команду Завершить.

Имеется также возможность одновременно завершить все серверные процессы, объединив шаги 4 и 7. Чтобы завершить все серверные процессы, выберите папку Мой компьютер и выполните команду Завершить серверные процессы из меню Действие.

5	Выберите пакет, для которого нужно включить безопасность.

6	Перейдите на вкладку Безопасность и установите флажок Включить проверку прав доступа.

7	Остановите серверный процесс пакета System, выбрав его, щелкнув правую кнопку мыши и выполнив команду Завершить.

После установки и настройки пакета на исходном сервере, может потребоваться блокировать пакет, чтобы конфигурация компонентов не могла быть изменена. Дополнительные сведения о блокировке конфигурации пакета содержатся в разделе Блокировка пакета MTS.

См. также

Пакет «System», Папка «Роли», Папка «Пользователи», Папка «Используемые роли», Выбор пользователей для ролей MTS, Руководство программиста Microsoft Transaction Server


Задание удостоверения пакета MTS

Имеется возможность настроить пакет (являющийся одиночным серверным процессом) для запуска с одним из следующих удостоверений пакета:

•	интерактивный пользователь;

•	заданная учетная запись пользователя Windows NT.

По умолчанию пакеты MTS запускаются с удостоверением интерактивного пользователя.

В большинстве сценариев развертывания лучше всего запускать пакет с удостоверением учетной записи Windows NT. Если пакет запускается с одной учетной записью Windows NT, имеется возможность настроить доступ к базе данных для этой учетной записи, вместо настройки доступа каждого клиента, использующего пакет. Разрешение доступа для учетных записей, а не для отдельных клиентов повышает масштабируемость приложения.

Например рассмотрим пакет Accounting, который обновляет сведения об оплате и продажах в базе данных сервера SQL Server. Имеется возможность в базе данных для таблицы Accounting предоставить доступ для чтения для пользователя Windows NT. .

Следует отметить, что при задании удостоверения пакета MTS проверяет вводимый пароль. Однако если для этой учетной записи пароль меняется без обновления пароля в MTS Explorer, пакет выполняться не будет.

Чтобы задать удостоверение пакета для указанной учетной записи пользователя:

1	Выберите пакет, удостоверение которого нужно изменить.

2	Выполните команду Свойства из меню Действие, а затем выберите вкладку Удостоверение.

3	Выберите параметр данного пользователя и введите домен пользователя, две обратных косых черты (\), имя и пароль пользователя для учетной записи Windows NT.

Следует отметить, что, если нужно использовать удостоверение пакета для ограничения доступа к базе данных, необходимо задать привилегии доступа к базе данных для данной учетной записи пользователя.

Важно! При создании безопасных приложений IIS, использующих изолированность процессов, IIS создает пакет MTS, который предназначен для запуска с именем IWAM_<имя компьютера>. Если нужно изменить удостоверение таких пакетов, следует добавить новое удостоверение пакета в группу «MTS Impersonators», или система безопасности не будет работать в других внешних компонентах MTS, вызываемых пакетом. Если это не выполнено, вызывающим клиентом будет, по-видимому, являться IWAM_<имя компьютера>, а не действительный клиент IIS.

См. также

Сопоставление ролей MTS с пользователями и группами, Включение безопасности пакета MTS, Добавление новой роли MTS, Вкладка «Удостоверение» (Пакет)


Добавление новой роли MTS

Хотя новые роли обычно добавляются во время разработки пакета, может потребоваться добавить новую роль к существующему пакету. Роли представляют набор привилегий системного уровня, которые требуются для выполнения определенной бизнес-функции. Роли задаются на уровне пакета. Для сопоставления пользователей и групп Windows NT с созданными ролями можно воспользоваться окном MTS Explorer.

Чтобы создать новую роль:

1	В левой области окна Explorer выберите пакет, для которого нужно добавить роль.

2	Откройте папку Роли.

3	Выполните команду Создать из меню Действие. Имеется также возможность в папке Роли нажать кнопку Создание нового объекта на панели инструментов MTS Explorer, либо щелкнуть правую кнопку мыши в папке Роли и последовательно выполнить команды Создать и Роль.

4	В следующем диалоговом окне введите имя для новой роли.

5	Нажмите кнопку ОК.

Внимание!   Безопасность пакета не будет включена, пока с ролью пакета не будет сопоставлен допустимый пользователь.

См. также

Сопоставление ролей MTS с пользователями и группами, Включение безопасности пакета MTS, Задание удостоверения пакета MTS, Папка «Роли», Выбор пользователей для ролей MTS


Сопоставление ролей MTS с пользователями и группами

При установке и развертывании приложения необходимо сопоставить пользователей и группы Windows NT с какими-нибудь существующими ролями. Роли определяют доступ пользователя к компонентам и интерфейсам.

Чтобы сопоставить пользователей с ролями:

1	В правой области окна Explorer выберите пакет, содержащий компонент, которому нужно присвоить роли.

2	Откройте папку Роли.

3	Дважды щелкните роль, которой нужно присвоить пользователей.

4	Откройте папку Пользователи.

5	Выполните команду Создать из меню Действие. Имеется также возможность в папке Пользователи нажать кнопку Создание нового объекта на панели инструментов MTS Explorer, либо щелкнуть правую кнопку мыши в папке Пользователи и последовательно выполнить команды Создать и Пользователи.

6	В следующем диалоговом окне добавьте к роли имена пользователей и групп. Для выбора учетной записи пользователя можно воспользоваться кнопками Пользователи и Найти.

7	Нажмите кнопку ОК.

Прмечание.  Чтобы добавить пользователя для роли на компьютере с системой Windows 98, необходимо настроить на компьютере Windows 98 управление доступом на уровне пользователей. Откройте панель управления Windows 98 и щелкните значок Сеть. Выберите вкладку Управление доступом, а затем выберите параметр "На уровне пользователей". За дополнительными сведениями обращайтесь к документации Windows 98.

См. также

Добавление новой роли MTS, Включение безопасности пакета MTS, Задание удостоверения пакета MTS, Папка «Роли», Папка «Пользователи», Выбор пользователей для ролей MTS


Обновление пакетов MTS

После того как пакет был успешно собран, распределен и развернут, администраторы имеют возможность обновлять пакеты MTS с помощью MTS Explorer. Обновление пакетов MTS заключается в наблюдении за состоянием и свойствами пакетов и их компонентов и, при необходимости, в перенастройке свойств пакетов и компонентов.

В разделе обсуждаются следующие вопросы:

Наблюдение за состоянием и свойствами в MTS Explorer

Использование окон свойств в MTS Explorer

Выбор пользователей для ролей MTS

Использование репликации MTS


Наблюдение за состоянием и свойствами в MTS Explorer

Имеется возможность использовать представления окна MTS Explorer Состояние и Свойства для наблюдения состояния и свойств активных пакетов и их компонентов. Для просмотра состояния и свойств объектов в окне Explorer выберите объект и нажмите кнопку Состояние или Свойства на панели инструментов MTS Explorer.

Представление Состояние позволяет просмотреть состояние компьютеров, пакетов и компонентов в окне Explorer. Например представление Состояние для папки «Компьютеры» указывает, был ли запущен Microsoft Distributed Transaction Coordinator (MS DTC), а представление Состояние для папки «Установленные пакеты» указывает, какие пакеты запущены. Представление Состояние для компонентов в пакете позволяет увидеть программный идентификатор (progID) компонента, а также число активизированных и вызываемых объектов. Можно использовать представление Состояние для быстрого просмотра состояния компьютеров и управляемых процессов приложений.

Чтобы просмотреть представление «Состояние» в MTS Explorer:

1	Выберите папку Установленные пакеты или папку Компоненты.

2	Нажмите кнопку Состояние на панели инструментов MTS в правой области MTS Explorer.

Примечание.   Представление Состояние не отображает состояние пакетов Utilities и System.

Воспользуйтесь представлением Свойства для быстрого сбора сведений о свойствах пакетов и компонентов. Например в этом представлении для компонентов отображается их программный код (ProgID), параметры транзакций, размещение библиотеки динамической компоновки (DLL), код класса (CLSID), потоковая модель и параметры безопасного доступа. Например можно использовать представление Свойства для быстрого просмотра свойств транзакций для всех компонентов пакета.

Чтобы просмотреть представление «Свойства» в MTS Explorer:

1	В правой области MTS Explorer выберите папку, состояние которой нужно просмотреть, например папку Установленные пакеты или Компоненты.

2	Нажмите кнопку Свойства на панели инструментов MTS Explorer. Свойства объектов данной папки будут показаны в столбцах в правой области MTS Explorer.

См. также

Использование окон свойств в MTS Explorer


Использование окон свойств в MTS Explorer

Окна свойств пакетов и компонентов позволяют изменить настройку пакетов MTS. Например если требуется изменить свойства транзакции компонента, имеется возможность изменить в окне свойств параметры транзакции. Перед перенастройкой значений специальных свойств прочитайте разделы Создание пакетов MTS и  Установка пакетов MTS с описаниями и процедурами по заданию разных свойств в MTS Explorer.

Изменения или удаления пакетов и их компонентов могут быть блокированы. Если пакет был блокирован во время установки или развертывания, потребуется разблокировать пакет перед изменением свойств его компонентов. Дополнительные сведения о блокировке содержатся в разделе Блокировка пакета MTS.

Чтобы настроить свойства пакета и приложения с помощью окна свойств:

1	Щелкните правой кнопкой мыши объект, свойства которого нужно задать. Имеется также возможность выбрать объект в левой области MTS Explorer и выполнить команду Свойства из меню Действие.

2	Измените нужное окно свойств и нажмите кнопку OK или Применить.

3	Обновите все компоненты для своего компьютера, выбирая значок «Мой компьютер» и выполняя команду Обновить все компоненты из меню Действие. Можно также обновить отдельные пакеты, выбирая папку «Установленные пакеты» и нажимая кнопку Обновить на панели инструментов MTS в правой области MTS Explorer.

Примечание   Если был изменен уровень активизации пакета, нужно завершить работу процесса пакета, прежде чем эти изменения вступят в силу. Для завершения работы процесса пакета щелкните пакет правой кнопкой мыши и выполните команду Завершить работу. Следует отметить, что работа пакетов, администрируемых с помощью удаленного доступа на компьютере MTS 1.x, не может быть завершена по отдельности.

См. также

Наблюдение за состоянием и свойствами в MTS Explorer


Выбор пользователей для ролей MTS

Администратор управляет ролями пользователей и групп Windows NT с помощью:

•	добавления к роли нового пользователя или группы;

•	удаления из роли пользователя или группы;

•	перемещения пользователя или группы из одной роли в другую.

При увеличении числа клиентов серверного пакета воспользуйтесь MTS Explorer для сопоставления новых пользователей с ролями для данного пакета. Дополнительные сведения по сопоставлению пользователей и ролей содержатся в разделе Сопоставление ролей MTS с пользователями и группами.

Возможно потребуется удалить пользователей из роли, либо переместить пользователей или группы из существующей роли в созданную заново роль. Например, если сотрудник уходит из организации, нужно удалить его из ролей, с которыми он был сопоставлен.

При создании новых ролей для существующего пакета возможно потребуется переместить пользователя или группу из одной роли в другую. Например при создании роли Clerk для пакета Accounting необходимо переместить некоторых пользователей или группы из существующей роли Manager (с привилегиями для чтения и записи данных пакета Accounting) в роль Clerk (с привилегиями только для чтения данных). Чтобы переместить пользователей или группы, необходимо удалить пользователя или группу из данной роли и сопоставить их с новой ролью.

Чтобы удалить пользователя из роли:

1	Найдите пакет, содержащий роль, из которой нужно удалить группу или пользователя. Выберите этот пакет в левой области окна MTS Explorer.

2	Откройте папку Роли.

3	Дважды щелкните роль, которая была определена для удаляемого пользователя.

4	Откройте папку Пользователи.

5	Выберите удаляемого пользователя.

6	Выполните команду Удалить из меню Действие. Можно также щелкнуть правую кнопку мыши и выполнить команду Удалить контекстного меню.

7	Нажмите кнопку Да в следующем диалоговом окне. Можно также удалить пользователя, выбрав его значок и нажимая кнопку Удалить.

См. также

Папка «Роли», Папка «Пользователи», Включение безопасности пакета MTS, Задание удостоверения пакета MTS, Добавление новой роли MTS, Сопоставление ролей MTS с пользователями и группами


Использование репликации MTS

MTS обеспечивает репликацию для использования с Microsoft Cluster Server (MSCS). Если на сервере в кластере происходит сбой, или он выключается, другой сервер перехватывает операции неисправного сервера.

Репликация сервера MTS

 Чтобы реплицировать сервер MTS:

1	Установите MTS на оба компьютера. Дополнительные сведения содержатся в разделе Настройка MTS с Microsoft Cluster Server.

2	Укажите главный компьютер и установите на него пакеты.

3	Зарегистрируйте все импортированные компоненты на обоих компьютерах.

4	Убедитесь, что связанные объекты, например библиотеки автономного выполнения, установлены на обоих компьютерах. (См. подраздел ограничений данного раздела.)

5	Укажите имя Общего ресурса репликации для главного компьютера на вкладке Параметры окна свойств Мой компьютер (см. подраздел «Репликация содержимого пакета» данного раздела).

6	Запустите с командной строки служебную программу MTXREPL.EXE.

Программа MTXREPL.EXE используется для репликации сервера MTS. Должны быть запущены главный и подчиненный компьютеры. MTXREPL.EXE имеет следующие аргументы:

MTXREPL.EXE главный подчиненный

Репликация MTS использует подход с одним главным компьютером при копировании сведений каталога MTS с главного компьютера на подчиненный компьютер. Для репликации на другой подчиненный компьютер вновь запустите программу MTXREPL.EXE. Подход с одним главным компьютером реализуется не очень строго, однако, таким образом, можно по очереди использовать подчиненный компьютер в качестве главного для репликации другого сервера MTS.

Во время репликации MTS полностью заменяет каталог на подчиненном компьютере каталогом с главного компьютера, за исключением того, что указано ниже в подразделе «Что не делает репликация MTS» данного раздела. Невозможно выполнение частичной репликации. При сбое репликации MTS, вновь запустите служебную программу MTXREPL.EXE.

Администраторы отвечают за инициацию репликации MTS и должны обеспечивать, чтобы изменения пакета на главном сервере реплицировались на все компьютеры кластера.

Желательно, чтобы репликация выполнялась, когда подчиненный компьютер не имеет запущенных компонентов MTS. При запуске MTS выводится сообщение об ошибке при чтении сведений каталога. Если репликация должна произойти в это время, запуск пакета произойдет со сбоем, и потребуется повторная попытка со стороны клиента.

Репликация пакетов IIS

Воспользуйтесь служебной программой репликации Microsoft Internet Information Server (IIS) версии 4.0 для репликации пакетов IIS. Репликация IIS автоматически копирует все сведения каталога MTS. Поэтому запуск служебной программы репликации MTS не является обязательным; фактически она не будет работать, если установлен IIS 4.0.

Репликация содержимого пакета

Репликация MTS копирует все необходимые компоненту библиотеки динамической компоновки (DLL), библиотеки типов и библиотеки объектов proxy-stub. Чтобы предоставить подчиненным компьютерам доступ к этим файлам, необходимо указать имя Общего ресурса репликации для главного компьютера на вкладке Параметры окна свойств папки Мой компьютер. Необходимо создать такую общую папку на главном компьютере и предоставить для нее привилегии только для чтения подчиненным компьютерам. Имя Общего ресурса репликации является сетевым именем, а не каталогом, с которым сопоставлено сетевое имя. Например, если имеется каталог d:\mtx\repl с сетевым именем MyReplPoint, то Общий ресурс репликации должен иметь значение MyReplPoint, а не d:\mtx\repl.

К общему ресурсу репликации должны быть предоставлены разрешения только для чтения для удостоверения пакета System на подчиненном компьютере. Если пакет System подчиненного компьютера выполняет проверку ролей, тогда удостоверение пакета System на главном компьютере должно принадлежать к роли Administrator пакета System на подчиненном компьютере.

Размещение библиотеки динамической компоновки первого компонента в пакете определяет, где установлены файлы на подчиненном компьютере. Если компонент размещен во вложенном каталоге используемого по умолчанию каталога пакета, этот вложенный каталог отображается на подчиненный компьютер. Используемый по умолчанию каталог пакета определяется во время установки MTS; например, если MTS установлен в c:\Program Files\Mts, то используемым по умолчанию каталогом установки пакетов является c:\Program Files\Mts\Packages.

Если пакеты установлены в этом каталоге, они будут иметь тот же относительный адрес к используемому по умолчанию каталогу пакета на подчиненном компьютере. Например,

Компьютер	Каталог пакет по умолчанию	Каталог установки пакета
главный	c:\Program Files\Mts\Packages	c:\Program Files\Mts\Packages\MyPak
подчиненный	d:\Mts\Packages	d:\Mts\Packages\MyPak
Пакеты, установленные не в используемый по умолчанию каталог пакета, устанавливаются во «внешний» подкаталог на подчиненном компьютере. Например для предыдущего примера

Компьютер	Каталог установки пакета
главный	Пакет A в c:\Program Files\Mts\Packages\MyPak пакет B в d:\misc
подчиненный	Пакеты A и B в d:\Mts\Packages\MyPak
Желательно установить пакеты в каталог пакетов, используемый по умолчанию. Желательно также, чтобы все файлы одного и того же пакета находились в одном и том же каталоге.

Администрирование кластеров серверов MTS

Администраторы должны всегда использовать физические имена компьютеров для администрации в кластере MSCS. Если на главном компьютере в кластере MSCS нужно просмотреть компьютер-копию, используйте физическое имя этого компьютера. Для репликации между главным и подчиненным компьютером используйте физические имена компьютеров.

Необходимо указать имя виртуального сервера в поле Имя удаленного сервера на вкладке Параметры окна свойств папки Мой компьютер для развертывания приложений MTS на кластере MSCS. При экспорте пакета с помощью служебной программы для исполняемых файлов приложений клиенты, которые затем установят приложение, будут направлены на этот виртуальный сервер. Если не задать Имя удаленного сервера, клиенты будут направлены на физический компьютер, что не является правильной настройкой для защиты с заменой при сбоях (failover).

Имеется также возможность выполнить статическое распределение загруженности для защиты с заменой при сбоях, указывая имена разных виртуальных серверов. Имея два имени для виртуальных серверов, по одному для каждого физического компьютера, можно создать исполняемый файл для установки клиента для пакетов, устанавливаемых на оба компьютера. При распространении этого дистрибутива среди клиентов и будет достигнуто статическое распределение загруженности.

 Чтобы распределить загруженность приложения MTS с помощью виртуальных серверов:

1	Определите способ распределения загруженности.

Например можно запускать все пакеты одновременно только на одном компьютере, запускать все пакеты на обоих компьютерах, либо запускать некоторые пакеты на одном, а другие пакеты на другом компьютере.

2	Воспользуйтесь администратором кластера MSCS (MSCS Cluster Administrator) для создания имен виртуальных серверов для обоих компьютеров.

3	Выполните экспорт пакетов с помощью имен виртуальных серверов, созданных на шаге 2.

Если нужно запускать все пакеты одновременно только на одном компьютере, выполните экспорт всех пакетов с одним именем виртуального сервера. Если требуется запускать все пакеты одновременно на обоих компьютерах, выполните экспорт всех пакетов дважды, по одному разу для каждого имени виртуального сервера. Затем необходимо распространить два разных набора клиентских установочных исполняемых файлов среди клиентов. Если хотите запускать половину пакетов на одном компьютере, а другую половину на другом, выполните экспорт каждой половины с помощью разных имен виртуальных серверов.

4	Запустите клиентские исполняемые файлы на компьютерах клиентов. В зависимости от того, какое распределение загруженности было выбрано на шаге 1, возможно наличие нескольких исполняемых файлов, выполняющихся на каждом клиенте.

Что не делает репликация MTS

Репликация MTS не выполняет следующие операции:

•	Установка MTS. Перед запуском репликации MTS необходимо установить MTS на каждом подчиненном компьютере.

•	Замена системных и служебных пакетов MTS и служебных пакетов IIS. Необходимо одинаково настроить эти пакеты на главном и подчиненных компьютерах (пути к файлам могут отличаться). MTS не делает этого автоматически; за необходимую синхронизацию обоих наборов пакетов отвечает администратор.

•	Репликация сведений, связанных с компьютером, например значений свойств Общий ресурс репликации и Имя удаленного сервера.

•	Репликация зависимых компонентов MTS, которые не могут быть обнаружены MTS, например библиотек автономного выполнения (run-time). Чтобы приложение правильно работало, необходимо копировать эти файлы на каждый подчиненный компьютер.

•	Репликация учетный записей системы безопасности локального компьютера. Такие учетные записи не рекомендуется использовать в кластерах для ролей или удостоверений пакетов.

•	Репликация исходных данных, на которых основано приложение. Например SQL Server обеспечивает автоматическую замену при сбое своих баз данных; необходимо гарантировать, что база данных настроена для замены при сбое и для приложения.

Ограничения

•	Репликация MTS не поддерживается на компьютерах с системой Windows 98.

•	Произойдет сбой репликации MTS, если на главном компьютере появятся некоторые удаленные компоненты, которые предназначены для запуска на подчиненном компьютере.

•	Импортированные компоненты могут реплицироваться только в том случае, если они уже зарегистрированы на подчиненных компьютерах. Установленные компоненты автоматически регистрируются и настраиваются для копии служебной программой репликации. При репликации компонентов, которые были импортированы на главный компьютер, служебная программа репликации предполагает, что эти компоненты уже зарегистрированы для копии. Необходимо вручную зарегистрировать импортированные компоненты на каждом подчиненном компьютере перед запуском служебной программы репликации.

•	Репликация не поддерживается в версиях MTS до версии MTS 2.0.

См. также

Настройка MTS с Microsoft Cluster Server, Вкладка «Параметры» (Компьютер)


Управление транзакциями MTS

Понимание того, как работают распределенные транзакции, помогает эффективно управлять транзакциями пакетов Microsoft Transaction Server (MTS). В данном разделе описывается, как работают транзакции, и как наблюдать за ними и управлять их работой в MTS Explorer.

В разделе обсуждаются следующие вопросы:

Представление о транзакциях MTS

Управление MS DTC

Наблюдение транзакций MTS

Наблюдение транзакций MTS под Windows 98

Представление о состояниях транзакций MTS

Определение транзакций MTS

См. также

Список транзакций, Статистика транзакций, Значки транзакций, Сообщения трассировки


Представление о транзакциях MTS

Microsoft Transaction Server (MTS) позволяет легко использовать, отслеживать и администрировать распределенные транзакции в приложениях. Распределенные транзакции представляют собой транзакции, включающие обновления защищенных транзакциями ресурсов в нескольких системах. Диспетчер транзакций MTS, Microsoft Distributed Transaction Coordinator (MS DTC), обеспечивают средства распределенных транзакций для систем Windows NT и Windows 98.

MS DTC делает также возможным обновление двух и более защищенных транзакциями ресурсов в одной системе. Например MS DTC позволяет обновлять базу данных Microsoft SQL Server, очередь сообщений Microsoft Message Queue Server и базу данных Oracle под управлением одной транзакции.

См. также

Управление MS DTC, Наблюдение транзакций MTS, Наблюдение транзакций MTS под Windows 98, Представление о состояниях транзакций MTS, Разрешение транзакций MTS


Управление MS DTC

Чтобы управлять транзакциями, необходимо сначала запустить Microsoft Distributed Transaction Coordinator (MS DTC). Запуск MS DTC позволяет:

•	MTS инициировать транзакции от имени компонентов транзакции;

•	компонентам транзакции MTS участвовать в транзакциях, инициированных другими сетевыми системами;

•	Microsoft SQL Server и Microsoft Message Queue Server (MSMQ) на одном сервере участвовать в транзакциях с компонентами MTS на другом сервере.

Если MS DTC не был запущен на сервере MTS, клиенты смогут получить доступ к пакетам транзакций, которыми требуется управлять, но серверные компоненты не смогут участвовать в транзакциях.

Примечание. Только для клиентской установки MS DTC пользователь должен иметь доступ на запись к локальному реестру и удаленный доступ на чтение к разделу реестра сервера Software\Classes, чтобы настраивать и запускать клиентов MS DTC на компьютере с системой Windows NT.

Для запуска MS DTC пользуйтесь MTS Explorer или (если MTS не установлен) панелью управления Windows NT.

Чтобы запустить или остановить MS DTC с помощью MTS Explorer:

1	В правой области окна MTS Explorer выберите компьютер, в который выполняется управление пакетами с транзакциями.

2	Откройте меню Действие и выполните команду Запустить MS DTC или Остановить MS DTC. Имеется также возможность щелкнуть правую кнопку мыши и выполните команду Запустить MS DTC или Остановить MS DTC контекстного меню.

Чтобы запустить или остановить MS DTC с помощью панели управления Windows NT:

1	Нажмите кнопку Пуск, выберите пункт Настройка, а затем —Панель управления.

2	Щелкните значок Службы.

3	Выберите в списке служб "MSDTC" и нажмите кнопку запуска.

4	Чтобы закрыть окно Службы, нажмите кнопку Закрыть.

По умолчанию служба Microsoft Distributed Transaction Coordinator (MS DTC) настроена на автоматический запуск при запуске системы Windows NT или Windows 98. Чтобы предотвратить автоматический запуск службы MS DTC после перезагрузки компьютера с системой Windows 98, воспользуйтесь редактором реестра, чтобы найти раздел HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunServices, а затем удалить запись с именем MSDTC. Чтобы предотвратить автоматический запуск MS DTC после перезагрузки компьютера Windows NT, щелкните значок Службы панели управления. Чтобы открыть окно настройки службы MS DTC, щелкните "MSDTC". В разделе Тип запуска, выберите Вручную.

Если нужно вновь включить автоматический запуск службы MS DTC на компьютере с системой Windows 98, воспользуйтесь редактором реестра для создания в разделе HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunServices параметра MSDTC со строковым значением "msdtcw -start". Запустить MS DTC можно с помощью значка Службы панели управления компьютера с системой Windows NT.

Важно! Рекомендуется настроить MS DTC для автоматического запуска на любом компьютере, на котором выполняются компоненты транзакций MTS, SQL Server или MSMQ.

Запуск и остановка MS DTC на кластерных серверах

На кластерном сервере имеется возможность запустить и остановить MS DTC с помощью MTS Explorer или с помощью административной служебной программы MSCS. Команды "net start msdtc" или "net stop msdtc" не работают. Чтобы запустить и остановить MS DTC на кластере MSCS с командной строки, воспользуйтесь командами "msdtc -start" и "msdtc -stop", соответственно.

Кроме того, можно настроить параметры DTC, такие как размещение или размер файла журнала DTC, с помощью вкладки Дополнительно окна свойств Компьютер.

Чтобы настроить параметры MS DTC:

1	В правой области окна MTS Explorer выберите компьютер, в который выполняется управление пакетами с транзакциями.

2	Откройте меню Действие и выполните команду Свойства. Можно также щелкнуть правую кнопку мыши и выполнить команду Свойства контекстного меню.

3	Выберите вкладку Дополнительно. Теперь можно настроить отображение транзакций в окнах «Список транзакций» и «Сообщения трассировки». Имеется также возможность изменить размещение и размер журнала MS DTC. Увеличение размера журнала MS DTC позволяет запускать большее число транзакций одновременно.

Важно! MS DTC имеет верхний предел на размер файла журнала:

•	в системе Windows NT он не должен превышать 512 Мбайт;

•	в системе Windows 98 он не должен превышать 64 Мбайт;

Сжатие файла журнала MS DTC

Файл журнала MS DTC может размещаться в сжатом каталоге. Однако для оптимального быстродействия не сжимайте файл журнала Microsoft DTC и не храните его в сжатом каталоге. MS DTC должен распаковывать файл журнала перед использованием.

Удаление файлов DTCXATM.LOG

Перед обновление версии установки MTS 2.0, удалите файл DTCXATM.LOG. Следует отметить, что необходимо остановить службу MS DTC перед удалением DTCXATM.LOG.

Безопасность и связь между удаленными компьютерами MS DTC

Если приложение выполняет транзакции, захватывающие два или более компьютера, необходимо убедиться, что службы MS DTC на этих компьютерах настроены на взаимодействие друг с другом. По умолчанию MS DTC выполняется с удостоверением учетной записи System. Служба MS DTC на одном компьютере имеет возможность взаимодействовать со службой MS DTC на другом компьютере, только если на обоих компьютерах доступны гостевые учетные записи (Guest). Если гостевые учетные записи отключены на каждом компьютере или в домене Windows NT, которому они принадлежат, необходимо настроить службу MS DTC на выполнение под каким-либо другим именем пользователя, который имеет возможность взаимодействовать с удаленным компьютером.

Примечание.  Для использования MS DTC в среде Microsoft Cluster Server (MSCS) необходимо установить Windows NT QFE Q116844. QFE исправляет неполадки службы RPC (Remote Procedure Call), которые могут вызывать зависание клиента MS DTC при попытке подключиться к MS DTC на кластеризованном сервере. Это исправление является также частью поправки Windows NT QFE1, доступной на Web-узле Windows NT Option Pack.

См. также

Представление о транзакциях MTS, Наблюдение транзакций MTS, Наблюдение транзакций MTS под Windows 98, Вкладка «Дополнительно» (Компьютер), Список транзакций, Статистика транзакций, Значки транзакций, Сообщения трассировки


Наблюдение транзакций MTS

Имеется возможность администрировать транзакции в приложениях MTS с помощью окон транзакций MTS Explorer. Окна «Сообщения трассировки», «Статистика транзакций» и «Список транзакций» предоставляют важные сведения о состоянии транзакций, управляемых Microsoft Distributed Transaction Coordinator (MS DTC).

Примечание. Транзакции прерываются автоматически, если они не завершаются за используемое по умолчанию время в 60 секунд. Чтобы изменить это время, воспользуйтесь вкладкой Параметры окна свойств «Мой компьютер».

Окно Список транзакций предназначено для определения следующих состояний. Дополнительные сведения содержатся в разделе Разрешение транзакций MTS.

Чтобы наблюдать за транзакциями с помощью окна «Список транзакций»:

1	В левой области окна MTS Explorer выберите компьютер, содержащий транзакции.

2	Дважды щелкните значок «Список транзакций».

3	Щелкните правую кнопку мыши с указателем в любом месте в области справа, и выберите пункт Вид контекстного меню.

4	В контекстном меню Вид выберите одну из следующих команд:

•	Крупные значки

Отображение транзакций в виде крупных значков.

•	Мелкие значки

Отображение транзакций в виде мелких значков.

•	Свойства

Отображение списка транзакций в один столбец и столбца свойств, содержащего код единицы работы, связанный с каждой транзакцией. Это глобальный уникальный идентификатор транзакции, создаваемый MS DTC при запуске транзакции. В списке присутствуют также родительские и подчиненные транзакции.

•	Список

Последовательное отображение транзакций в столбец.

Примечание.   Команды Мелкие значки и Список отображают наибольшее число транзакций одновременно. Свойства предоставляют наиболее полные сведения о транзакциях, а Крупные значки отображают транзакции в наиболее удобном виде.

Чтобы просмотреть статистику транзакций:

1	В левой области окна MTS Explorer выберите компьютер, на котором нужно просмотреть статистику транзакций.

2	Дважды щелкните значок «Статистика транзакций».

Чтобы просмотреть сообщения трассировки:

1	В левой области окна MTS Explorer выберите компьютер, содержащий транзакции.

2	Дважды щелкните значок «Сообщения трассировки».

Окно «Статистика транзакций» MS DTC отображается в области справа.

Свойства транзакции

Для просмотра свойств транзакции выберите ее правой кнопкой мыши и выполните команду Свойства контекстного меню. Команда Свойства перечисляет всех диспетчеров транзакций, вовлеченных в транзакцию. Для дочерней транзакции команда Свойства перечисляет непосредственные родительские транзакции. Если транзакция является родительской транзакцией, указываются непосредственные дочерние транзакции.

См. также

Представление о транзакциях MTS, Наблюдение транзакций MTS под Windows 98, Представление о состояниях транзакций MTS, Разрешение транзакций MTS, Список транзакций, Статистика транзакций, Значки транзакций, Сообщения трассировки


Наблюдение транзакций MTS под Windows 98

Для управления транзакциями MTS на компьютерах Windows 98 или Windows NT служат следующие окна MTS Explorer:

•	Статистика транзакций

•	Список транзакций

•	Сообщения трассировки

По умолчанию служба Microsoft Distributed Transaction Coordinator (MS DTC) настроена на автоматический запуск при запуске системы Windows NT или Windows 98. Чтобы предотвратить автоматический запуск службы MS DTC после перезагрузки компьютера с системой Windows 98, воспользуйтесь редактором реестра, чтобы найти раздел HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunServices, а затем удалить запись с именем MSDTC. Если нужно вновь включить автоматический запуск службы MS DTC, воспользуйтесь редактором реестра для создания записи MSDTC со строковым значением "msdtcw -start" в разделе HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\RunServices.

Примечание.   Чтобы настроить и запустить клиентов MS DTC на компьютере Windows NT, пользователь должен иметь доступ для записи к локальному реестру и удаленный доступ для чтения к записи сервера Software\Classes.

Если необходимо использовать удаленное администрирование компьютера Windows NT с компьютера Windows 98, необходимо установить службу Remote Registry для Windows 98. Служба Remote Registry позволяет изменять записи реестра для удаленного компьютера Windows NT (если предоставить ей нужные разрешения). Чтобы найти службу Remote Registry, перейдите в каталог \Admin\Nettols\Remotereg на компакт-диске Windows 98. Инструкции по установке службы содержатся в файле Regserv.txt.

Поскольку Windows 98 не ведет журнал событий, события MS DTC сохраняются в текстовом файле msdtc.txt. Файл msdtc.txt содержится в подкаталоге \MTSLogs каталога Windows и содержит сведения о событиях MS DTC.

При сбросе файла журнала MS DTC в системе Windows 98 может появиться диалоговое окно "MTxOCI", за которым последует сообщение об ошибке «Сбой создания файла журнала MS DTC». В этом случае необходимо отключить автоматический запуск MS DTC. Перезапустите компьютер и выполните сброс файла журнала. Затем можете вновь включить автоматический запуск службы MS DTC.

Для устранения других неполадок, связанных со сбросом файла журнала службы MS DTC, закройте и перезапустите MTS Explorer, а затем попытайтесь вновь выполнить сброс журнала. В некоторых случаях для исправления файла журнала MS DTC необходимо завершить работу и вновь запустить MTS Explorer несколько раз.

См. также

Представление о транзакциях MTS, Наблюдение транзакций MTS, Список транзакций MTS, Статистика транзакций, Значки транзакций, Сообщения трассировки


Представление о состояниях транзакций MTS

Чтобы управлять транзакциями, необходимо понимать разные состояния транзакции и их влияние на управляемый пакет MTS. Состояния транзакции представляются в виде следующих «Крупных значков» в окне «Список транзакций» службы Microsoft Distributed Transaction Coordinator (MS DTC):

Значок	Описание
	Активна Транзакция была запущена
	Прерывается Транзакция прерывается. MS DTC уведомляет всех участников, что транзакция должна быть прервана. В это время невозможно изменить исход транзакции.
	Прервана Транзакция прервана. Все участники были уведомлены. После того, как транзакция прервана, она немедленно удаляется из списка транзакций в окне транзакций MS DTC. В это время невозможно изменить исход транзакции.
	Готовится Клиентское приложение выдало запрос на завершение. MS DTC собирает запросы от всех участников.
	Готова Все участники ответили положительно на запрос о подготовке.
	Не определена Транзакция подготовлена, координируется другой службой MS DTC, и эта координирующая служба MS DTC недоступна. Системный администратор может вызвать завершение или прерывание транзакции, щелкнув правой кнопкой мыши в окне транзакций и выбрав команды Разрешить/Завершить или Разрешить/Прервать. После выбора исхода транзакция помечается как принудительно завершенная или принудительно прерванная. Внимание!  Не форсируйте вручную транзакции в неопределенном состоянии, пока не прочитаете раздел Разрешение транзакций MTS.
	Принуд. завершена Администратор форсировал завершение транзакции, находящейся в неопределенном состоянии (см. раздел Разрешение транзакций MTS).
	Принуд. прервана Администратор форсировал прерывание транзакции, находящейся в неопределенном состоянии (см. раздел Разрешение транзакций MTS).
	Завершается Транзакция успешно подготовлена, и MS DTC уведомляет участников о том, что транзакция была завершена. MS DTC не завершает транзакцию, пока все участники не подтвердят получение (и запись) запроса на завершение. В это время невозможно изменить исход транзакции.
	Сбой уведомления о прерывании MS DTC уведомил всех подключенных участников, что транзакция прервана. Не уведомлены только недоступные в данное время участники. Такое состояние транзакции возникает, когда MS DTC должен информировать какой-либо диспетчер ресурсов (например систему IBM LU 6.2), что транзакция прервана, но не может это выполнить, поскольку связь с системой IBM разорвана. Системный администратор может отложить транзакцию, щелкнув правой кнопкой мыши в окне транзакций и выбрав команды Разрешить/Отложить. Внимание!  Не форсируйте вручную транзакции, пока не прочитаете раздел Разрешение транзакций MTS.
	Сбой уведомления о завершении MS DTC уведомил всех подключенных участников, что транзакция завершена. Не уведомлены только недоступные в данное время участники. Системный администратор может отложить транзакцию, щелкнув правой кнопкой мыши в окне транзакций и выбрав команды Разрешить/Отложить. Внимание!  Не форсируйте вручную транзакции, пока не прочитаете раздел Разрешение транзакций MTS.
	Завершена Транзакция была завершена и все участники были уведомлены. После того, как транзакция завершается, она немедленно удаляется из списка транзакций в окне транзакций MS DTC.  В это время невозможно изменить исход транзакции.
См. также

Представление о транзакциях MTS, Наблюдение транзакций MTS, Наблюдение транзакций MTS под Windows 98, Разрешение транзакций MTS, Список транзакций


Разрешение транзакций MTS

При администрировании транзакций MTS, может потребоваться вручную разрешить транзакцию для приложения MTS. Имеется возможность воспользоваться для разрешения транзакции окном «Список транзакций» MTS Explorer и выбрать одну из следующих команд:

•	Завершить  Это приведет к принудительному завершению транзакции.

•	Прервать  Эта команда вызывает принудительное завершение транзакции и возвращение ее исходного состояния.

•	Отложить  Эта команда удаляет завершенную или прерванную транзакцию из журнала Microsoft Distributed Transaction Coordinator (MS DTC). Следует всегда принудительно вызвать окончание транзакции перед использованием данной команды.

Иногда необходимо принудительно завершить или прервать транзакцию для освобождения блокировок и предоставления доступа к ресурсам базы данных для других сетевых пользователей и приложений.

Это требуется, например, когда разрывается линия связи между двумя компьютерами в сети. После того как транзакция вручную завершается или прерывается, часто бывает необходимо также вручную заставить компьютер «отложить» транзакцию, то есть удалить транзакцию из локального файла журнала MS DTC.

Далее приводится случай, когда транзакция завершается вручную. В примере предполагается следующее:

•	Служба MS DTC на компьютере A является координатором завершения.

•	Линии связи, с которыми связан протокол двухэтапного завершения транзакций, обрабатываются последовательно от компьютера A к компьютеру D.

•	На первом этапе протокола MS DTC записывает в свой журнал запись COMMITTED.

•	Связь между компьютерами B и C разрывается на втором этапе.

Транзакция остается в следующем неопределенном состоянии:

Поскольку линия связи между компьютерами A и B еще работает, на компьютере B транзакция также завершается. Оба компьютера, однако, должны сохранять записи COMMITTED в своих файлах журнала, пока компьютеры C и D не подтвердят, что они также завершили транзакцию. Чтобы разрешить транзакцию (и, таким образом, освободить блокировки базы данных на компьютерах C и D), системный администратор должен принудительно завершить транзакцию на компьютере C (см. следующий рисунок).

Поскольку линия связи между компьютерами C и D еще работает, принудительное завершение транзакции на компьютере C позволяет завершить ее на компьютере D. Компьютер D теперь может освободить свои блокировки базы данных и отложить эту транзакцию. Как только компьютер D подтверждает для компьютера C, что он завершил работу и отложил транзакцию, компьютер C может также освободить свои блокировки и отложить транзакцию.

Транзакция теперь завершена на всех компьютерах. Однако поскольку компьютер C не может сообщить о своем завершении работы для компьютера B, компьютер B должен продолжать сохранение транзакции в памяти. Поскольку компьютер B не откладывает транзакцию, компьютер A также должен хранить ее в памяти. Чтобы завершить транзакцию, системный администратор заставляет компьютер B отложить транзакцию (см. следующий рисунок). Это позволяет компьютеру A также отложить транзакцию. Протокол двухэтапного завершения транзакции был проведен вручную, и работа транзакции была завершена.

Важно.   Из-за модели связи «вход-выход» протокола двухэтапного завершения транзакций желательно вручную разрешать транзакции на компьютерах сразу после разрыва связи. Таким образом, в предыдущем примере принудительное завершение транзакции происходит на компьютере C (не на D), а принудительное откладывание транзакции происходит на компьютере B (не на A).

Обычно, когда системны, вовлеченные в транзакции, перезапускаются и связь после сбоя системы или подключения восстанавливается, MS DTC автоматически разрешает транзакции. MS DTC не может разрешить транзакции, если система завершила работу, или подключения не могут быть восстановлены. В этом случае, можно вручную разрешить транзакции, находящиеся в неопределенном состоянии, транзакции, которые не могут отправить уведомления о прерывании или о завершении, при наличии сбоя системы или подключения.

Неопределенное состояние

Неопределенное состояние указывает, что транзакция является дочерней транзакцией, которая была подготовлена MS DTC, и родитель MS DTC недоступен. Чтобы разрешить транзакцию в неопределенном состоянии, предпримите следующие шаги:

1	Воспользуйтесь окном «Список транзакций», чтобы найти непосредственного родителя такой транзакции. Чтобы это выполнить, щелкните транзакцию правой кнопкой мыши и выполните команду Свойства. При этом отображаются родительские и дочерние компьютеры MS DTC для данной транзакции.

2	Найдите родителя MS DTC и воспользуйтесь окном «Список транзакций» на родительском компьютере для определения исхода транзакции в неопределенном состоянии.

•	Если транзакция не появляется в окне «Список транзакций», то она была прервана, и можно вручную прервать транзакцию на дочернем компьютере.

•	Если транзакция появляется на родительском компьютере с сообщением «Сбой уведомления о завершении», то транзакция была завершена, и ее можно вручную завершить на дочернем компьютере.

•	Если транзакция появляется на родительском компьютере с сообщением «Сбой уведомления о прерывании», то транзакция была прервана, и ее можно вручную прервать на дочернем компьютере.

•	Если транзакция показывается в неопределенном состоянии на родительском компьютере, воспользуйтесь окном «Список транзакций» на родительском компьютере, чтобы найти следующего непосредственного родителя транзакции. Продолжайте следовать по транзакциям вверх по дереву завершения, пока не найдете родителя, на котором транзакция также не показывается (это указывает на то, что она прервана), имеет состояние «Сбой уведомления о прерывании» (указывающее, что она прервана) или состояние «Сбой уведомления о завершении» (указывающее, что она завершена). Если транзакция прервана на родительском компьютере, вручную прервите транзакцию на непосредственном дочернем компьютере данного компьютера. Если транзакция завершена на родительском компьютере, вручную завершите транзакцию на дочернем компьютере данного компьютера.

3	Как только вручную завершили или прервали транзакцию на дочернем компьютере, принудительно отложите транзакцию на непосредственном родителе.

Сбой уведомления о завершении

Состояние «Сбой уведомления о завершении» указывает, что транзакция была завершена, но некоторые подчиненные службы MS DTC не были уведомлены. Имеется возможность вручную разрешить транзакцию следующим образом: Щелкните правой кнопкой мыши транзакцию, находящуюся в состоянии «Сбой уведомления о завершении». При этом отображаются родительские и подчиненные службы MS DTC для данной транзакции. Найдя подчиненные службы MS DTC, принудительно завершите транзакции для каждой из них. Как только транзакция вручную завершена на всех подчиненных MS DTC, вернитесь к службе MS DTC, которая показывает транзакцию в состоянии «Сбой уведомления о завершении», и заставьте эту службу MS DTC отложить транзакцию.

Внимание!   Не откладывайте транзакцию вручную, пока об исходе транзакции не будут уведомлены все подчиненные службы MS DTC.

Сбой уведомления о прерывании

Состояние «Сбой уведомления о прерывании» указывает, что транзакция была прервана, но некоторые подчиненные службы MS DTC не были уведомлены. Это состояние аналогично состоянию «Прерывается». Имеется возможность вручную разрешить транзакцию следующим образом: Щелкните правой кнопкой мыши транзакцию, находящуюся в состоянии «Сбой уведомления о прерывании». При этом отображаются родительские и подчиненные службы MS DTC для данной транзакции. Найдя подчиненные службы MS DTC, принудительно прервите транзакции для каждой из них. Как только транзакция вручную прервана на всех подчиненных MS DTC, вернитесь к службе MS DTC, которая показывает транзакцию в состоянии «Сбой уведомления о прерывании», и заставьте эту службу MS DTC отложить транзакцию.

Внимание!   Не откладывайте транзакцию вручную, пока об исходе транзакции не будут уведомлены все подчиненные службы MS DTC.

Чтобы разрешить транзакцию:

1	В левой области окна MTS Explorer выберите компьютер, на котором нужно разрешить транзакцию.

2	Дважды щелкните значок «Список транзакций».

3	В области справа щелкните правой кнопкой мыши транзакцию, которую нужно разрешить.

4	В подменю Разрешить выберите пункт Завершить, Прервать или Отложить.

См. также

Представление о транзакциях MTS, Управление MS DTC, Наблюдение транзакций MTS, Наблюдение транзакций MTS под Windows 98, Представление о состояниях транзакций MTS, Список транзакций


Автоматизация администрирования MTS

Разработчики Microsoft Transaction Server (MTS) и опытные администраторы Web могут использовать административные объекты сценариев для автоматизации развертывания и администрирования приложений MTS. Объекты сценариев соответствуют иерархии семейства Microsoft Transaction Server Explorer. Имеется возможность автоматизировать процедуры администрирования, вызывая интерфейсы нужного административного объекта сценариев. На следующем рисунке показаны типы семейств, администрируемых и развертываемых с помощью MTS Explorer:

Чтобы эффективно использовать административные объекты сценариев, следует хорошо понимать задачи, автоматизируемые приложением в MTS Explorer. Для разработки приложения можно использовать любой язык программирования, поддерживающий программирование объектов OLE, поскольку административные объекты сценариев создаются из интерфейса IDispatch. Рекомендуется применять средства разработки Microsoft Visual Basic версии 5.0 или более поздней и Microsoft Visual C++ версии 5.0 или более поздней, которые поддерживают ActiveX и COM. Полный пример на языке Visual Basic, демонстрирующий использование административных объектов сценариев, содержится в справочнике администратора MTS.

В разделе обсуждаются следующие вопросы:

Объекты администрирования MTS

Пример сценария Visual Basic для автоматизации администрирования MTS

Пример приложения Visual Basic для автоматизации администрирования MTS

Автоматизация администрирования MTS с помощью Visual Basic

Автоматизация расширенного администрирования MTS с помощью Visual Basic

См. также

Справочник администратора MTS


Объекты администрирования MTS

Следующие объекты сценариев используются для администрирования:

Объект Catalog

Объект CatalogObject

Объект CatalogCollection

Объект PackageUtil

Объект ComponentUtil

Объект RemoteComponentUtil

Объект RoleAssociationUtil

Эти объекты обеспечивают общий и служебный интерфейсы для различных целей сценариев. Объекты Catalog, CatalogObject и CatalogCollection заключают в себе слой объектов семейства каталогов и обеспечивают функциональность верхнего уровня, например создание и изменение объектов. Объект Catalog позволяет подключаться к определенным серверам и обращаться к семействам. Вызов объекта CatalogCollection позволяет составлять список, создавать, удалять и изменять объекты, а также получать доступ к связанным семействам. Объект CatalogObject используется для получения и задания свойств объекта.

На слое служебных объектов каталогов объекты PackageUtil, ComponentUtil, RemoteComponentUtil и RoleAssociationUtil позволяют выполнять более конкретные задачи, например установку компонентов и экспорт пакетов. Служебный слой позволяет программировать специфические задачи для типов семейств, например установку связи роли с пользователем или классом пользователей.

На следующем рисунке показано, как программа настройки использует методы для административных объектов, чтобы прочитать и записать данные каталога.

Дополнительные сведения о получении примеров администрирования и справочная документация содержатся в разделе Установка примеров и документации для разработчика MTS.

См. также

Справочник администратора MTS

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Использование объектов семейства каталога MTS

Каждая папка MTS Explorer соответствует семейству, хранящемуся в каталоге. Объекты Catalog, CatalogObject и CatalogCollection заключают в себе слой объектов семейства каталога. Эти объекты позволяют автоматизировать в приложениях общие процедуры администрирования, например создание, удаление или изменение объектов.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Создание экземпляра объекта MTS CatalogCollection

Нетрудно создать экземпляр объекта CatalogCollection для получения доступа к любому типу семейств или данных из любой папки MTS Explorer. Чтобы создать экземпляр объекта CatalogCollection, воспользуйтесь методом GetCollection и укажите имя семейства. Объект CatalogCollection является универсальным объектом, используемым для доступа к любому типу семейств (например к данным из любой папки Explorer). Имеется возможность вызвать метод GetCollection объекта Catalog для получения семейства верхнего уровня. Можно также вызвать метод GetCollection объекта CatalogCollection для получения связанного семейства.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Заполнение объекта MTS CatalogCollection

Воспользуйтесь административными объектами для заполнения объекта CatalogCollection данными из каталога. Следует отметить, что при создании экземпляра объекта никакие данные не читаются из каталога. Чтобы просмотреть или изменить данные в семействе, вызовите сначала метод Populate или PopulateByKey. Метод Populate прочитает все данные семейства. PopulateByKey прочитает только указанные объекты. Не требуется заполнять семейство для добавления в него данных или для использования интерфейса служебных объектов.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Восстановление объектов MTS и получение/задание свойств

Объект CatalogCollection поддерживает методы перебора объектов семейства. При использовании средства разработки Visual Basic это выполняется с помощью инструкции For Each. В Visual C++ для перебора семейства вызовите методы Item и Count. Доступ к свойствам объекта осуществляется с помощью свойства Value объекта при задании в качестве параметра имени свойства.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Создание новых объектов MTS

Некоторые семейства поддерживают метод Add для создания нового объекта. В других семействах для установки объектов (например компонентов) требуется использовать служебный интерфейс. Дополнительные сведения содержатся в разделе Использование объектов семейства каталога MTS.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Сохранение изменений объектов MTS

Изменение свойств, а также создание объектов (с помощью метода Add) и удаление объектов (с помощью метода Remove, который поддерживает большинство семейств) выполняются в памяти, пока не будет вызван метод SaveChanges. При вызове метода SaveChanges все изменения объекта CatalogCollection применяются к каталогу. Если освободите объект CatalogCollection перед вызовом метода SaveChanges или вызовите метод Populate или PopulateByKey до вызова метода SaveChanges, все несохраненные изменения будут потеряны.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Использование служебных объектов каталога MTS

Слой служебных объектов состоит из объектов PackageUtil, ComponentUtil, RemoteComponentUtil и RoleAssociationUtil. Эти объекты используются для выполнения специфических действий непосредственно в каталоге (например установку компонентов или готовых пакетов). Служебные объекты являются специфическими для каждого конкретного типа семейства. Для получения служебного объекта вызовите метод GetUtilInterface для объекта CatalogCollection.

При использовании служебного объекта выполненные в каталоге изменения не влияют на объект CatalogCollection, из которого был получен служебный объект. Чтобы просмотреть любые изменения, необходимо вызвать метод Populate или PopulateByKey для объекта CatalogCollection. Не требуется вызывать метод SaveChanges после использования служебного метода, поскольку изменения немедленно записываются в каталог.

См. также

Объекты администрирования MTS, Использование типов семейств MTS, Методы административных объектов MTS


Обработка ошибок каталога MTS

Семейство каталога и служебные методы каталога возвращают значение HRESULTS, которое указывает их успешное выполнение или сбой. В Visual Basic версии 5 воспользуйтесь дескриптором On Error и объектом Err для перехвата этих ошибок и доступа к программе обработки. Методы, связанные со многими объектами (например метод SaveChanges или InstallPackage), могут перехватывать несколько кодов ошибок для описания специфических сбоев объектов. К этому набору кодов можно получить доступ с помощью семейства ErrorInfo. Для доступа к семейству ErrorInfo можно воспользоваться методом GetCollection. Каждый объект CatalogCollection, для которого был создан экземпляр, обновляет семейство ErrorInfo, хранящее коды ошибок для последнего сбойного вызова метода. При установке пакета можно увидеть, какие компоненты уже установлены, с помощью семейства ErrorInfo для данного объекта.

Желательно программировать приложение с проверкой успешного вызова каждого метода. Программа должна специально проверять код возврата E_INVALIDARG (ошибка выполнения 5 в Visual Basic версии 5) при предоставлении имен семейств или имен свойств. Этот код указывает, что одно или несколько из предоставленных семейств или свойств не поддерживаются.

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Семейство MTS ErrorInfo


Примеры сценариев Visual Basic для автоматизации администрирования MTS

Имеется возможность использовать язык совместимый с программированием объектов OLE, например Visual Basic Scripting Edition (VBScript), для вызова административных объектов. MTS предоставляет примеры сценариев администрирования для демонстрации использования объектов сценариев для автоматизации процедур MTS Explorer.

Чтобы запустить сценарий автоматизации вне HTML-страницы, необходимо иметь на компьютере установленную службу WSH (Windows Scripting Host). WSH представляет собой служебную программу для запуска сценариев с командной строки, которая устанавливается с помощью пакета Window NT 4.0 Option Pack для компьютеров Windows NT. WSH позволяет выполнять сценарии непосредственно с рабочего стола или с командной строки Windows. Не требуется встраивать эти сценарии в документ HTML; вместо этого сценарии могут запускаться непосредственно с рабочего стола, выбирая щелчком файл сценария, либо с командной строки. Дополнительные сведения содержатся в документации по Windows Scripting Host.

Чтобы продемонстрировать использование административных объектов в сценарии, запустите примеры сценариев, содержащиеся в подкаталоге \Program Files\Mts\Samples. Подкаталог WSH содержит следующие пять примеров сценариев, написанные на языке VBScript:

•	InstDLL.vbs

•	InstPak.vbs

•	Uninst.vbs

•	InstDllCLI.vbs

•	InstPakCLI.vbs

Эти сценарии автоматизируют процедуры администрирования приложения «Sample Bank». Например сценарий InstDLL.vbs InstDll.vbs вызывает объекты сценариев для удаления существующих версий приложения «Sample Bank», создает новый пакет с именем «Sample Bank», устанавливает компоненты из библиотек «Sample Bank» для Visual Basic, Visual C++ и Visual J++ в этот новый пакет, изменяет атрибуты транзакций и добавляет новую роль. Сценарий InstPak.vbs также использует объекты сценариев для установки приложения «Sample Bank», а сценарий Uninst.vbs автоматизирует удаление установки пакета «Sample Bank» из MTS. После выполнения сценария можно просмотреть результаты сценария в MTS Explorer после нажатия кнопки Обновить панели инструментов.

Чтобы использовать сценарии InstDLL.vbs, InstPak.vbs и Uninst.vbs, необходимо изменить путь к файлам в сценарии, чтобы он указывал размещение требуемых файлов на компьютере. Например путь к файлу в сценарии InstPak.vbs задает стандартное размещение пакета «Sample Bank»:

path="C:\Program Files\Mts\Samples\Packages\"

Если пакет «Sample Bank» был установлен в другой каталога, измените эту строку в сценарии, чтобы указать текущее размещение пакета.

Сценарии InstDllCLI.vbs и InstPakCLI.vbs поддерживают параметры командной строки, поэтому имеется возможность указать расположение файла в качестве параметре при запуске сценария в окне консоли. В окне командной строки откройте каталог, содержащий нужный сценарий, и введите имя сценария и расположение пакета или библиотек. Например, чтобы установить пакет «Sample Bank», размещенный в стандартном каталоге, откройте каталог, содержащий примеры сценариев и введите следующую команду в командную строку:

InstPakCLI.vbs "C:\Program Files\Mts\Samples\Packages\"

Чтобы воспользоваться сценарием InstDLL.vbs, необходимо сначала выполнить одно из следующих действий, чтобы зарегистрировать Java-компоненты в файле vjacct.dll:

•	установите пакет, запуская сценарий InstDLL.vbs;

•	зарегистрируйте Java-компоненты с помощью мастера ActiveX из Microsoft Visual Studio 97.

См. также

Установка учебных административных сценариев MTS


Пример приложения Visual Basic для автоматизации администрирования MTS

Примеры приложения Visual Basic версии 5.0 демонстрируют использование методов объектов Catalog, CatalogObject и CatalogCollections для автоматизации основных функций администрирования для пакета «Scriptable Admin Demo».

Примечание.   Необходимо настроить проект Visual Basic версии 5.0 для ссылки на административную библиотеку типов MTS (MTSAdmin). Для задания ссылки на библиотеку типов MTSAdmin нажмите кнопку References (Ссылки) на панели инструментов Visual Basic Project. Затем найдите среди доступных для ссылок файлов «MTS 2.0 Admin Type Library». Для переменных с поздней привязкой (которая происходит во время выполнения программы) Visual Basic будет искать библиотеку типов без дополнительной настройки, если файл MTXADMIN.DLL зарегистрирован на локальном компьютере.

Чтобы удалить любой существующий пакет с именем «Scriptable Admin Demo»:

1	Вызовите метод CreateObject для создания экземпляра объекта-каталога.

Dim catalog As Object

Set catalog = CreateObject("MTSAdmin.Catalog.1")

2	Получите объект семейства Packages с помощью вызова метода GetCollection. Семейство Packages возвращается без загрузки каких-либо данных из каталога, так что семейство будет пустым при возвращении из метода GetCollection.

Dim packages As Object

Set packages = catalog.GetCollection("Packages")

3	Выполните поиск предыдущих версий пакета «Scriptable Admin Demo», перебирая семейство Packages и читая все пакеты с поиском имени «Scriptable Admin Demo». Просмотрите все семейство, начиная с максимального индекса, чтобы внутри этого цикла можно было вызвать метод Remove. Метод Remove освобождает объект, удаляет его из семейства и смещает объекты семейства так, чтобы объект (n+1) стал объектом (n), для всех n больше или равных удаляемому индексу. Результат метода Remove немедленно отражается на объекте семейства. Методы Item и Count, вызываемые в любое время после метода Remove, будут учитывать изменения индекса. Однако удаление пакета не применяется к каталогу, пока не будет вызван метод SaveChanges (см. пункт 4).

packages.Populate

Dim pack As Object

n = packages.Count

For i = n - 1 To 0 Step -1

    If packages.Item(i).Value("Name") = "Scriptable Admin Demo" Then

        packages.Remove (i)

End If

Next

4	Вызовите метод SaveChanges для сохранения изменений в хранилище данных.

packages.SaveChanges

Чтобы создать новый пакет «Scriptable Admin Demo Package»:

1	Добавьте новый пакет с помощью метода Add и запомните присвоенный пакету код. Метод Add добавляет объект в семейство, но не применяет изменения к каталогу, пока не будет вызван метод SaveChanges (см. пункт 3). Следует отметить, что метод Add присваивает стандартные значения всем свойствам. По умолчанию в качестве кода задается новый уникальный идентификатор.

Dim newPack As Object

Dim newPackID As Variant

Set newPack = packages.Add

newPackID = newPack.Value("ID")

2	Обновите свойства Name и SecurityEnabled.

newPack.Value("Name") = "Scriptable Admin Demo"

newPack.Value("SecurityEnabled") = "N"

3	Вызовите метод SaveChanges для сохранения нового пакета в каталоге. Значение возврата данного вызова содержит число измененных, добавленных или удаленных объектов. Если изменений не было, метод возвращает 0.

n = packages.SaveChanges

Чтобы обновить свойства пакета «Scriptable Admin Demo» и получить семейство ComponentsInPackage:

1	Вызовите метод PopulateByKey для обратного чтения пакета из каталога. Передайте массив, содержащий ключи объектов для чтения. В примере используется массив, содержащий единственный элемент (код только что созданного пакета).

Dim keys(0) as Variant

keys(0) = newPackId

packages.PopulateByKey keys

2	Получите объект пакета из семейства

Dim package As Object

Set package = packages.Item(0)

3	 Обновите для пакета свойство SecurityEnabled.

package.Value("SecurityEnabled") = "Y"

4	Вызовите метод GetCollection для восстановления семейства ComponentsInPackage. Предоставьте в качестве параметра ключ пакета «Scriptable Admin Demo».

Set components = packages.GetCollection("ComponentsInPackage",_ 	  package.Key)

5	Вызовите метод SaveChanges для сохранения изменений в каталоге.

packages.SaveChanges

Чтобы установить компонент в качестве стандартного для пакета «Scriptable Admin Demo package»:

1	Вызовите метод GetUtilInterface для получения служебного объекта компонента. Этот объект используется для установки компонентов.

Dim util As Object

Set util = components.GetUtilInterface

On Error GoTo installFailed

2	Вызовите метод InstallComponent, передавая в строке имя библиотеки динамической компоновки (DLL) устанавливаемого компонента. Если компонент не имеет внешней библиотеки типов или библиотеки объектов proxy-stub, передайте в качестве второго и третьего аргументов пустые строки. Следует отметить, что не следует вызывать метод SaveChanges после установки нового компонента. Все компоненты, содержащиеся в библиотеке динамической компоновки, будут установлены данным методом и немедленно записаны в каталог. Вызовите метод GetCLSIDs для получения кодов CLSID установленных компонентов.

Form2.Show 1

Dim thePath As String

thePath = Form2.MTSPath + "\samples\packages\vbacct.dll"

util.InstallComponent thePath, "", ""

Dim installedCLSIDs() as Variant

util.GetCLSIDs thePath, «», installedCLSIDs

On Error GoTo 0

3	Вызовите метод PopulateByKey, чтобы считать обратно только что установленные компоненты. Следует отметить, что установленные с помощью метода InstallComponent компоненты пакета недоступны в семействе, пока не будет вызван метод Populate или PopulateByKey, чтобы прочитать данные из каталога.

components.PopulateByKey installedCLSIDs

Чтобы найти и удалить компонент Bank.CreateTable из пакета «Scriptable Admin Demo»:

1	Переберите компоненты и измените атрибуты транзакций с помощью методов Item и Count.

Dim component As Object

n = components.Count

For i = n - 1 To 0 Step -1

    Set component = components.Item(i)

    component.Value("Transaction") = "Required"

2	Найдите и удалите по индексу компонент Bank.CreateTable. Следует отметить, что необходимо перебирать семейство в обратном порядке, чтобы в процессе выполнения цикла вызывать метод Remove.

If component.Value("ProgID") = "Bank.CreateTable" Then

        components.Remove (i)

    End If

Next

3	Загрузите новый счетчик и вновь переберите семейство. Следует отметить, что компонент Bank.CreateTable не будет удален из хранилища данных, пока не будет вызван метод SaveChanges. Выведите окно сообщения, сообщающее пользователю об успешном выполнении установки.

n = components.Count

For i = 0 To n - 1

    Set component = components.Item(i)

    Debug.Print component.Value("ProgID")

    Debug.Print component.Value("DLL")

Next

n = components.SaveChanges

MsgBox "Пакет ‘Scriptable Admin Demo’ установлен и настроен."

Exit Sub

installFailed:

    MsgBox "Код ошибки " + Str$(Err.Number) + " установка " + thePath + "  Убедитесь, что введен правильный путь к MTS, и vbacct.dll еще не установлена."

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic, Автоматизация расширенного администрирования MTS с помощью Visual Basic


Автоматизация администрирования MTS с помощью Visual Basic

Административные объекты сценариев могут использоваться для установки, удаления и обновления свойств пакетов и компонентов. Эти разделы рассматривают пример процедуры и пример программы на языке Microsoft Visual Basic версии 5.0, использующие методы административных объектов сценариев для автоматизации следующих задач администрирования:

•	Автоматизация установки готового пакета MTS

•	Автоматизация создания пакета MTS и установки компонентов

•	Автоматизация перебора установленных пакетов MTS для обновления свойств

•	Автоматизация перебора установленных пакетов MTS для удаления пакета

•	Автоматизация перебора установленных пакетов MTS для удаления компонента

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация установки готового пакета MTS

 Чтобы установить готовый пакет «Test.pak» в MTS Explorer:

1	Опишите объекты, которые будут использоваться для установки готового пакета.

Private Sub InstallPackage_Click()

    Dim catalog As Object

    Dim packages As Object

    Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages верхнего уровня, вызывая метод GetCollection.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

   Set packages = catalog.GetCollection("Packages")

4	Создайте экземпляр объекта PackageUtil и вызовите метод InstallPackage для установки пакета «test.pak».

Set util = packages.GetUtilInterface

    util.InstallPackage "c:\test.pak", "", 0

    Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    	MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация создания пакета MTS и установки компонентов

Чтобы создать новый пакет «My Package» и установить его компоненты:

1	Опишите объекты, которые будут использоваться для создания нового пакета, и установите компоненты в этот пакет.

Dim catalog As Object

    Dim packages As Object

    Dim newPack As Object

    Dim componentsInNewPack As Object

    Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages верхнего уровня из объекта CatalogCollection, вызывая метод GetCollection. Затем вызовите метод Add для добавления нового пакета.

Set catalog = CreateObject("MTSAdmin.Catalog.1")
Set packages = catalog.GetCollection("Packages")

Set newPack = packages.Add

Dim newPackID As String

4	Задайте имя пакета «My Package» и сохраните изменения в семействе Packages.

    newPackID = newPack.Key

   	 newPack.Value("Name") = "My Package"

   	 packages.SaveChanges

5	Вызовите метод GetCollection для доступа к семейству ComponentsInPackage. Затем создайте экземпляр объекта ComponentUtil, чтобы вызвать метод InstallComponent для заполнения нового пакета компонентами.

Set componentsInNewPack = 	packages.GetCollection("ComponentsInPackage", newPackID)

  	  Set util = componentsInNewPack.GetUtilInterface

   	 util.InstallComponent"d:\dllfilepath", "", ""

   	 Exit Sub

6	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация перебора установленных пакетов MTS для обновления свойств

Чтобы перебрать установленные пакеты для обновления свойств пакета «My Package»:

1	Опишите объекты, которые будут использоваться для перебора установленных пакетов, чтобы обновить свойства пакета.

Private Sub BrowseUpdate_Click()

Dim catalog As Object

Dim packages As Object

Dim pack As Object

Dim componentsInNewPack As Object

Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Затем вызовите метод Populate для заполнения семейства пакетами из каталога.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

packages.Populate

4	Переберите семейство, чтобы найти пакет «My Package». Когда будет найден пакет «My Package», задайте для свойства SecurityEnabled значение «Y». Вызовите метод SaveChanges для сохранения обновленного свойства данного пакета.

For Each pack In packages

        If pack.Name = "My Package" Then

            pack.Value("SecurityEnabled") = "Y"

            Exit For

        End If

    Next

packages.SaveChanges

    Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

 End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация перебора установленных пакетов MTS для удаления пакета

Чотбы перебрать установленные пакеты для удаления пакета «My Package»:

1	Опишите объекты, которые будут использоваться для перебора установленных пакетов, чтобы удалить определенный пакет.

Dim catalog As Object

Dim packages As Object

Dim pack As Object

Dim componentsInPack As Object

Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Затем вызовите метод Populate для заполнения семейства установленными пакетами из каталога.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

packages.Populate

4	Воспользуйтесь методами Count и Item для перебора семейства пакетов, чтобы найти пакет «My Package». Когда пакет «My Package» будет найден, вызовите метод Remove для удаления пакета. Затем сохраните изменения семейства, вызывая метод SaveChanges.

For i = 0 To packages.Count-1

        Set pack = packages.Item(i)

        If pack.Name = "My Package" Then

            packages.Remove (i)

            packages.savechanges

            Exit For

        End If

    Next

    Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация перебора установленных пакетов MTS для удаления компонента

Чтобы перебрать установленные компоненты для удаления компонента:

1	Опишите объекты, которые будут использоваться для перебора установленных компонентов, чтобы удалить определенный компонент.

Dim catalog As Object

Dim packages As Object

Dim pack As Object

Dim componentsInPack As Object

Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Затем вызовите метод Populate для заполнения семейства установленными пакетами из каталога.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

packages.Populate

4	Переберите семейство, чтобы найти пакет «My Package». Вызовите метод GetCollection для получения семейства ComponentsInPackage. Заполните семейство ComponentInPackages с помощью метода Populate, а затем переберите семейство, чтобы найти компонент «Bank.Account». Вызовите метод Remove для удаления компонента и сохраните изменения семейства, вызывая метод SaveChanges.

For Each pack In packages

        If pack.Name = "My Package" Then

            Set componentsInPack = packages.GetCollection("ComponentsInPackage", pack.Key)

            componentsInPack.Populate

            For i = 0 To componentsInPack.Count

                Set comp = componentsInPack.Item(i)

                If comp.Name = "Bank.Account" Then

                    componentsInPack.Remove (i)

                    componentsInPack.savechanges

                    Exit For

                End If

Next

            Exit For

        End If

    Next

    Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация расширенного администрирования MTS с помощью Visual Basic

Административные объекты сценариев могут использоваться для настройки клиентов и ролей, экспорта пакетов и доступа к именам семейств и свойств, поддерживаемым каталогом. В следующих разделах рассматриваются примеры процедуры и программы на языке Visual Basic версии 5.0, использующие методы административных объектов сценариев для автоматизации следующих задач администрирования:

•	Автоматизация доступа к именам связанных семейств MTS

•	Автоматизация доступа к сведениям о свойствах MTS

•	Автоматизация настройки ролей MTS

•	Автоматизация экспорта пакета MTS

•	Автоматизация настройки клиента MTS на использование удаленных компонентов

•	Автоматизация обновлений свойств пакета MTS на удаленных серверах


Автоматизация доступа к именам связанных семейств MTS

Семейство RelatedCollectionInfo предоставляет список связанных семейств, к которым имеется доступ из данного семейства. Список свойств, поддерживаемых данным семейством, содержится в разделе RelatedCollectionInfo справочника администратора MTS.

Чтобы получить доступ и отобразить имена связанных семейств:

1	Опишите объекты, которые будут использоваться для доступа к объектам, предоставляющим имена связанных семейств.

Dim catalog As Object

Dim packages As Object

Dim RelatedCollectionInfo As Object

Dim collName As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Затем вызовите метод GetCollection для объекта семейства Packages, чтобы получить семейство RelatedCollectionInfo. Следует отметить, что ключевое значение остается пустым при вызове GetCollection для доступа к семейству RelatedCollectionInfo. Ключевое значение не используется, поскольку сведения в RelatedCollectionInfo будут одинаковыми для всех пакетов. Заполните семейство RelatedCollectionInfo сведениями из каталога, вызывая метод Populate.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

Set RelatedCollectionInfo =_ packages.GetCollection("RelatedCollectionInfo", "")

RelatedCollectionInfo.Populate

4	Переберите семейство RelatedCollectionInfo и выведите на экран имена каждого семейства.

For Each collName In RelatedCollectionInfo

   Debug.Print collName.Name

Next

Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация доступа к сведениям о свойствах MTS

Семейство PropertyInfo хранит сведения о каждом свойстве в семействе. Дополнительные сведения о данным семействе содержатся в разделе PropertyInfo справочника администратора MTS.

Чтобы получить доступ к свойсвам и список имен каждого свойства семейства:

1	Опишите объекты, которые будут использоваться для доступа к сведениям о свойствах, хранящимся в каталоге.

Dim catalog As Object

Dim packages As Object

Dim propertyInfo As Object

Dim property As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Вызовите метод GetCollection для объекта семейства Packages, чтобы получить семейство PropertyInfo. Следует отметить, что ключевое значение остается пустым при вызове GetCollection для доступа к семейству PropertyInfo. Ключевое значение не используется, поскольку сведения в PropertyInfo будут одинаковыми для всех пакетов. Заполните семейство PropertyInfo сведениями из каталога, вызывая метод Populate.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

Set propertyInfo = packages.GetCollection("PropertyInfo", "")

propertyInfo.Populate

4	Переберите семейство PropertyInfo и выведите на экран имена каждого свойства в семействе.

For Each property In propertyInfo

        Debug.Print property.Name

    Next

    Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки пакета.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация настройки ролей MTS

Чтобы настроить роль пакета и компонента, а также присвоить пользователю привилегии администратора:

1	Опишите объекты, которые будут использоваться для настройки роли определенного компонента.

Dim catalog As Object

Dim packages As Object

Dim pack As Object

Dim comp As Object

Dim newUser As Object

Dim newRole As Object

Dim componentsInPack As Object

Dim RolesInPackage As Object

Dim usersInRole As Object

Dim rolesForComponent As Object

Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Затем заполните семейство Packages данными из каталога.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

packages.Populate

4	Переберите семейство Packages, чтобы найти пакет «My Package». Когда пакет «My Package» будет найден, вызовите метод GetCollection для получения семейства RolesInPackage. Добавьте новую роль в пакет с помощью метода Add. Назовите новую роль «R1» и сохраните изменения в семействе.

    If pack.Name = "My Package" Then

 Set rolesInPack = packages.GetCollection("RolesInPackage", pack.Key)

            Set newRole = rolesInPack.Add

            newRole.Value("Name") = "R1"

            rolesInPack.savechanges

5	Вызовите метод GetCollection для семейства RolesInPackage, чтобы получить семейство UsersInRole. Воспользуйтесь функцией Add для добавления в роль существующего пользователя NT. Задате имя пользоватля «administrator». Сохраните изменения в семействе UsersInRole.

            Set usersInRole = RolesInPackage.GetCollection("UsersInRole", 	newRole.Key)

            Set newUser = usersInRole.Add

            newUser.Value("User") = "administrator"

            usersInRole.savechanges

6	Получите семейство ComponentsInPackage с помощью метода GetCollection. Заполните семейство ComponentsInPackage и переберите его, чтобы найти компонент Bank.Account. Чтобы сопоставить новую роль с компонентом, создайте экземпляр объекта RoleAssociationUtil с помощью метода GetUtilInterface. Затем сопоставьте новую роль с компонентом, вызывая метод AssociateRole.

Set componentsInPack = packages.GetCollection("ComponentsInPackage", pack.Key)

            componentsInPack.Populate

            For Each comp In componentsInPack

                If comp.Name = "Bank.Account" Then

                    Set rolesForComponent = componentsInPack.GetCollection("RolesForPackageComponent", comp.Key)

                    Set util = rolesForComponent.GetUtilInterface

                    util.associateRole (newRole.Key)

                    Exit For

                End If

            Next

            Exit For

        End If

    Next

    Exit Sub

7	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки компонента.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация экспорта пакета MTS

Чтобы выполнить экспорт пакета «test.pak»:

1	Опишите объекты, которые будут использоваться для экспорта пакета.

Dim catalog As Object

Dim packages As Object

Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство Packages, вызывая метод GetCollection. Вызовите метод Populate для заполнения пакета данными из каталога.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set packages = catalog.GetCollection("Packages")

packages.Populate

4	Переберите семейство Packages, чтобы найти пакет «My Package». После обнаружения пакета создайте экземпляр служебного объекта пакета и вызовите метод ExportPackage.

For Each pack In packages

        If pack.Name = "My Package" Then

            Set util = packages.GetUtilInterface

            util.ExportPackage pack.Key, "c:\test.pak", 0

            Exit For

        End If

    Next

Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки компонента.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация настройки клиента MTS на использование удаленных компонентов

Чтобы настроить клиент для использования удаленного компонента Bank.CreateTable:

1	Опишите объекты, которые будут использоваться для настройки клиента (с работающим MTS) для запуска удаленных компонентов.

Dim catalog As Object

Dim remoteComps As Object

Dim util As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Загрузите семейство RemoteComponents, вызывая метод GetCollection. Затем создайте экземпляр объекта RemoteComponentUtil с помощью метода GetUtilInterface. Чтобы установить удаленный компонент, вызовите метод InstallRemoteComponentByName и укажите имя компьютера сервера, имя пакета на сервере и имя компонента.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set remoteComps = catalog.GetCollection("RemoteComponents")

Set util = remoteComps.GetUtilInterface

util.InstallRemoteComponentByName "remote1", "New","Bank.CreateTable"

Exit Sub

4	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки компонента.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


Автоматизация обновлений свойств пакета MTS на удаленных серверах

Чтобы обновить свойства пакета на удаленном компьютере с именем «remote1»:

1	Опишите объекты, которые будут использоваться для настройки клиента (с работающим MTS) для развертывания и администрирования удаленных компонентов.

Dim catalog As Object

Dim packages As Object

Dim pack As Object

Dim root As Object

2	Используйте инструкцию On Error для обработки ошибок выполнения, если метод возвращает значение сбоя HRESULT. Имеется возможность проверить и обработать перехватываемые ошибки MTS с помощью инструкции On Error и объекта Err.

On Error GoTo failed

3	Вызовите метод CreateObject для создания экземпляра объекта Catalog. Вызовите метод Connect для доступа к корневому семейству на компьютере с именем «remote1». Корневое семейство является объектом-семейством, который может использоваться для доступа к семействам верхнего уровня на данном компьютере. Корневое семейство не содержит объектов и не имеет свойств. Следует отметить, что ключевое значение не используется при вызове GetCollection из корневого семейства. Получите семейство Packages на удаленном компьютере, вызывая метод GetCollection. Затем воспользуйтесь методом Populate для заполнения семейства пакетов.

Set catalog = CreateObject("MTSAdmin.Catalog.1")

Set root = catalog.Connect("remote1")

Set packages = root.GetCollection("Packages", "")

packages.Populate

4	Задайте для SecurityEnabled значение «Y» для «My Package» и сохраните изменения в семействе пакетов.

 For Each pack In packages

        If pack.Name = "My Package" Then

            pack.Value("SecurityEnabled") = "Y"

            Exit For

        End If

    Next

    packages.savechanges

    Exit Sub

5	Воспользуйтесь объектом Err для отображения сообщения об ошибке при сбое установки компонента.

failed:

    MsgBox "Код ошибки " + Str$(Err.Number)

End Sub

См. также

Объекты администрирования MTS, Типы семейств MTS, Методы административных объектов MTS, Автоматизация администрирования MTS с помощью Visual Basic


MTS Overview and Concepts

How Does MTS Work?

Explains the elements of Microsoft Transaction Server and how they work together to provide the infrastructure and programming model to develop and deploy components.

MTS Programming Concepts

Explains the key concepts that a component application developer needs to understand for developing applications.


How Does MTS Work?

This topic describes the elements of Microsoft Transaction Server (MTS) and explains how they provide the infrastructure and programming model to develop and deploy MTS components.

Elements of MTS

Contents

Application Components

MTS Executive

Server Processes

Resource Managers

Resource Dispensers

Microsoft Distributed Transaction Coordinator

MTS Explorer


Application Components

Application components model the activity of a business. These components implement the business rules, providing views and transformations of the application state. Consider, for example, the case of an online bank. Records in one or more database systems represent the durable state of the business, such as the amount of money in an account. The application components update that state to reflect such changes as debits and credits.

MTS shelters developers from complex server issues, allowing them to focus on implementing business functions. Because components running in the MTS run-time environment can take advantage of transactions, developers can write applications as if they run in isolation. MTS handles the concurrency, resource pooling, security, context management, and other system-level complexities. The transaction system, working in cooperation with database servers and other types of resource managers, ensures that concurrent transactions are atomic, consistent, have proper isolation, and that, once committed, the changes are durable. For more information on the benefits of transactions, see Transactions.

MTS also makes it easier to build distributed applications by providing location transparency. MTS automatically loads the component into a process environment. An MTS component can be loaded into a client application process (in-process component), or into a separate surrogate server process environment, either on the client's computer (local component) or on another computer (remote component).

In-process, local, and remote components

MTS Components and COM

MTS components are COM in-process server components contained in (DLLs). They are distinguished from other COM components in that they execute in the MTS run-time environment. You can create and implement these components with Visual Basic, Visual C++, Visual J++, or any ActiveX-compatible development tool.

Note that the term component represents the code that implements a COM object. For example, Visual C++ components are implemented as classes. Likewise, Visual Basic components are implemented by class modules.

MTS imposes specific requirements on components beyond those required by COM (see MTS Component Requirements). This allows MTS to provide services to the component that would not otherwise be possible. These include increased scalability and robustness and simplified system management.

See Also

Base Clients vs. MTS Components, MTS Objects, Business Logic in MTS Components, Server Processes


MTS Executive

The MTS Executive is a dynamic-link library (DLL) that provides run-time services for MTS components, including thread and context management. This DLL loads into the processes that host application components and runs in the background.

MTS also provides a set of resource dispensers that simplify access to shared resources in a server process. For more information, see Resource Dispensers.

See Also

Application Components


Server Processes

A server process is a system process that hosts the execution of an application component. A server process can host multiple components and can service tens, hundreds, or potentially thousands of clients. You can configure multiple server processes to execute on a single computer. Each server process reflects a separate trust boundary and fault isolation domain.

Other process environments can also host application components. As a result, you can deploy applications that meet varying distribution, performance, and fault isolation requirements. For example, you can configure MTS components to be loaded directly into Microsoft Internet Information Server (IIS). You can also configure them to load directly into client processes.

Server Process


Resource Managers

A resource manager is a system service that manages durable data. Server applications use resource managers to maintain the durable state of the application, such as the record of inventory on hand, pending orders, and accounts receivable. Resource managers work in cooperation with the Microsoft Distributed Transaction Coordinator to guarantee atomicity and isolation to an application.

MTS supports resource managers, such as Microsoft SQL Server version 6.5, that implement the OLE Transactions protocol.

See Also

Resource Dispensers, Microsoft Distributed Transaction Coordinator


Resource Dispensers

A resource dispenser manages nondurable shared state on behalf of the application components within a process. Resource dispensers are similar to resource managers, but without the guarantee of durability. MTS provides two resource dispensers:

•	The ODBC resource dispenser

•	The Shared Property Manager

ODBC Resource Dispenser

The ODBC resource dispenser manages pools of database connections for MTS components that use the standard ODBC interfaces, allocating connections to objects quickly and efficiently. Connections are automatically enlisted on an object's transactions, and the resource dispenser can automatically reclaim and reuse connections. The ODBC 3.0 Driver Manager is the ODBC resource dispenser; the Driver Manager DLL is installed with MTS.

Shared Property Manager

The Shared Property Manager provides synchronized access to application-defined, process-wide properties (variables). For example, you can use it to maintain a Web-page hit counter or to maintain the shared state for a multiuser game.

See Also

ISharedPropertyGroupManager Interface, Creating a Simple ActiveX Component, Sharing State


Microsoft Distributed Transaction Coordinator

The Microsoft Distributed Transaction Coordinator (MS DTC) is a system service that coordinates transactions. Work can be committed as an atomic transaction even if it spans multiple resource managers, potentially on separate computers.

MS DTC was first released as part of Microsoft SQL Server version 6.5 and is included in MTS, providing a low-level infrastructure for transactions. MS DTC implements a two-phase commit protocol to ensure that the transaction outcome (either commit or abort) is consistent across all resource managers involved in a transaction. MS DTC ensures atomicity, regardless of failures.

See Also

Resource Managers


MTS Explorer

You can use the MTS Explorer to deploy application components. You can also use it to view and manipulate items in the MTS run-time environment.

For a complete discussion of using the MTS Explorer for application administration, see the Administrator's Guide.


MTS Programming Concepts

This topic explains the key concepts that a component application developer needs to understand to develop Microsoft Transaction Server (MTS) applications.

Contents

Transactions

MTS Objects

MTS Clients

Activities

Components and Threading

Programmatic Security

Error Handling


Transactions

MTS simplifies the task of developing application components by allowing you to perform work with transactions. This protects applications from anomalies caused by concurrent updates or system failures.

Transactions maintain the ACID properties:

•	Atomicity ensures that all the updates completed under a specific transaction are committed and made durable, or that they get aborted and rolled back to their previous state.

•	Consistency means that a transaction is a correct transformation of the system state, preserving the state invariants.

•	Isolation protects concurrent transactions from seeing each other's partial and uncommitted results, which might create inconsistencies in the application state. Resource managers use transaction-based synchronization protocols to isolate the uncommitted work of active transactions.

•	Durability means that committed updates to managed resources, such as a database record, survive failures, including communication failures, process failures, and server system failures. Transactional logging even allows you to recover the durable state after disk media failures.

The intermediate states of a transaction are not visible outside the transaction, and either all the work happens or none of it does. This allows you to develop application components as if each transaction executes sequentially and without regard to concurrency. This is a tremendous simplification for application developers.

You can declare that a component is transactional, in which case MTS associates transactions with the component's objects. When an object's method is executed, the services that resource managers and resource dispensers perform on its behalf execute under a transaction. This can also include work that it performs for other MTS objects. Work from multiple objects can be composed into a single atomic transaction.

Multiple objects composed into a transaction

Without transactions, error recovery is extremely difficult, especially when multiple objects update multiple databases. The possible combinations of failure modes are too great even to consider. Transactions simplify error recovery. Resource managers automatically undo the transaction's work, and the application retries the entire business transaction.

Transactions also provide a simple concurrency model. Because a transaction's isolation prevents one client's work from interfering with other clients, you can develop components as though only a single client executes at a time.

Components Declare Transactional Requirements

Every MTS component has a transaction attribute that is recorded in the MTS catalog. MTS uses this attribute during object creation to determine whether the object should be created to execute within a transaction, and whether a transaction is required or optional. For more information on transaction attributes, see Transaction Attributes.

Components that make updates to multiple transactional resources, such as database records, for example, can ensure that their objects are always created within a transaction. If the object is created from a context that has a transaction, the new context inherits that transaction; otherwise, the system automatically initiates a transaction.

Components that only perform a single transactional update can be declared to support, but not require, transactions. If the object is created from a context that has a transaction, the new context inherits that transaction. This allows the work of multiple objects to be composed into a single atomic transaction. If the object is created from a context that does not have a transaction, the object can rely on the resource manager to ensure that the single update is atomic.

How Work Is Associated with a Transaction

An object's associated context object indicates whether the object is executing within a transaction and, if so, the identity of the transaction.

Resource dispensers can use the context object to provide transaction-based services to the MTS object. For example, when an object executing within a transaction allocates a database connection by using the ODBC resource dispenser, the connection is automatically enlisted on the transaction. All database updates using this connection become part of the transaction, and are either atomically committed or aborted. For more information, see Enlisting Resources in Transactions.

Stateful and Stateless Objects

Like any COM object, MTS objects can maintain internal state across multiple interactions with a client. Such an object is said to be stateful. MTS objects can also be stateless, which means the object does not hold any intermediate state while waiting for the next call from a client.

When a transaction is committed or aborted, all of the objects that are involved in the transaction are deactivated, causing them to lose any state they acquired during the course of the transaction. This helps ensure transaction isolation and database consistency; it also frees server resources for use in other transactions.

Completing a transaction enables MTS to deactivate an object and reclaim its resources, thus increasing the scalability of the application. Maintaining state on an object requires the object to remain activated, holding potentially valuable resources such as database connections. Stateless objects are more efficient and are thus recommended. For more information on object deactivation, see Deactivating Objects.

How Objects Can Participate in Transaction Outcome

You can use methods implemented on the IObjectContext interface to enable an MTS object to participate in determining a transaction's outcome. The SetComplete, SetAbort, DisableCommit, and EnableCommit methods work in conjunction with the component's transaction attribute to allow one or more objects to be composed simply and safely within transactions.

•	SetComplete indicates that the object has successfully completed its work for the transaction. The object is deactivated upon return from the method that first entered the context.

•	SetAbort indicates that the object's work can never be committed. The object is deactivated upon return from the method that first entered the context.

•	EnableCommit indicates that the object's work is not necessarily done, but that its transactional updates can be committed in their current form.

•	DisableCommit indicates that the object's transactional updates can not be committed in their current form.

Both SetComplete and SetAbort deactivate the object on return from the method. MTS reactivates the object on the next call that requires object execution.

Objects that need to retain state across multiple calls from a client can protect themselves from having their work committed prematurely by the client. By calling DisableCommit before returning control to the client, the object can guarantee that its transaction cannot successfully be committed without the object doing its remaining work and calling EnableCommit.

Client-Controlled vs. Automatic Transactions

Transactions can either be controlled directly by the client, or automatically by the MTS run-time environment.

Clients can have direct control over transactions by using a transaction context object. The client uses the ITransactionContext interface to create MTS objects that execute within the client's transactions, and to commit or abort the transactions.

Transactions can automatically be initiated by the MTS run-time environment to satisfy the component's transaction expectations. MTS components can be declared so that their objects always execute within a transaction, regardless of how the objects are created. This feature simplifies component development, because you do not need to write application logic to handle the special case where an object is created by a client not using transactions.

This feature also reduces the burden on client applications. Clients do not need to initiate a transaction simply because the component that they are using requires it.

MTS automatically initiates transactions as needed to satisfy a component's requirements. This event occurs, for example, when a client that is not using transactions creates an object in an MTS component that is declared to require transactions.

MTS completes automatic transactions when the MTS object that triggered their creation has completed its work. This event occurs when returning from a method call on the object after it has called SetComplete or SetAbort. SetComplete causes the transaction to be committed; SetAbort causes it to be aborted.

A transaction cannot be committed while any method is executing in an object that is participating in the transaction. The system behaves as if the object disables the commit for the duration of each method call.

See Also

Building Transactional Components, Multiple Transactions


Transaction Attributes

Every MTS component has a transaction attribute. The transaction attribute can have one of the following values:

•	Requires a transaction. This value indicates that the component's objects must execute within the scope of a transaction. When a new object is created, its object context inherits the transaction from the context of the client. If the client does not have a transaction, MTS automatically creates a new transaction for the object.

•	Requires a new transaction. This value indicates that the component's objects must execute within their own transactions. When a new object is created, MTS automatically creates a new transaction for the object, regardless of whether its client has a transaction.

•	Supports transactions. This value indicates that the component's objects can execute within the scope of their client's transactions. When a new object is created, its object context inherits the transaction from the context of the client. If the client does not have a transaction, the new context is also created without one.

•	Does not support transactions. This value indicates that the component's objects do not run within the scope of transactions. When a new object is created, its object context is created without a transaction, regardless of whether the client has a transaction.

Most MTS components are declared as either Supports transactions or Requires a transaction. These values allow an object to execute within the scope of its client's transaction. You can see the difference between these values when an object is created from a context that does not have a transaction. If the component's transaction attribute is Supports transactions, the new object runs without a transaction. If it is declared as Requires a transaction, MTS automatically initiates a transaction for the new object.

Declaring a component as Requires a new transaction is similar to using Requires a transaction in that the component's objects are guaranteed to execute within transactions. However, when you declare the transaction attribute this way, an object never runs inside the scope of its client's transaction. Instead, the system always creates independent transactions for the new objects. For example, you can use this for auditing components that record work done on behalf of another transaction regardless of whether the original transaction commits or aborts.

Specifying Does not support transactions ensures that an object's context does not contain a transaction. This value is the default setting and is primarily used with versions of COM components that precede MTS.

Setting the Transaction Attribute

The transaction attribute is part of a component definition. The component developer determines it, and changes to it are not recommended.

You can set a transaction attribute at development time by:

•	Using values defined in Mtxattr.h. You can specify these values in an .odl file to encode them into the component's type library.

•	Using the MTS Explorer to create a package file for deploying your components.

Because Because Microsoft Visual Basic automatically generates a type library, Visual Basic developers must use the MTS Explorer to set the transaction attribute.

See Also

Application Components, Transactions


Enlisting Resources in Transactions

MTS provides automatic transactions, which means that transaction requirements are declared as component properties. MTS automatically begins transactions and commits or aborts these transactions on behalf of the component, based on the component's transaction property.

Automatic transactions work because resource dispensers pass transactions to the resource manager. For example, the ODBC Driver Manager is a resource dispenser for ODBC database connections. When a database connection is requested from a transactional component, the ODBC Driver Manager obtains the transaction from the object's context. The ODBC Driver Manager then associates (enlists) the database connection with the transaction.

If you do not have a resource dispenser, you can build your own using the Microsoft Transaction Server Beta Software Development Kit (SDK), available at http://www.microsoft.com/support/transactions/. For more information, see the Resource Dispenser Guide and the samples included with the MTS Beta SDK.

For a resource manager to participate in an MTS transaction, it must support one of the following protocols:

•	OLE Transactions

•	The X/Open DTP XA standard

OLE Transactions, the object-oriented, two-phase commit protocol defined by Microsoft, is the preferred protocol. OLE Transactions is based on the Component Object Model (COM) and is used by resource managers in order to participate in distributed transactions coordinated by Microsoft Distributed Transaction Coordinator (DTC). OLE Transactions is supported by Microsoft SQL Server version 6.5. For more information on supporting OLE Transactions, see the Resource Manager Guide and the samples included with the MTS Beta SDK.

XA is the two-phase commit protocol defined by the X/Open DTP group. XA is natively supported by many Unix databases, including Informix, Oracle, and DB2.

For MTS to work with XA-compliant resource managers, an OLE Transactions-to-XA mapper, provided by the MTS Beta SDK, makes it relatively straightforward for XA-compliant resource managers to provide resource dispensers that can accept OLE Transactions from MTS and translate to XA. For more information, see "Mapping OLE Transactions to the XA Protocol" in the MTS Beta SDK, or contact your resource manager vendor.

See Also

Resource Dispensers, Transactions


Determining Transaction Outcome

This section discusses how applications determine whether a transaction will commit or abort.

First, it is important to understand that the MTS objects involved in a transaction do not need to know the transaction outcome. All objects involved in a transaction are automatically deactivated. Deactivation causes the objects to lose any state that they acquired during the transaction. Consequently, their behavior is not affected by the outcome of the transaction.

Each object can participate in determining the outcome of a transaction. Objects call SetComplete, SetAbort, EnableCommit, and DisableCommit, based on the desired component behavior. For example, an object would typically call SetAbort after receiving an error from a database operation, on a method call to another object, or due to a violation of a business rule such as an overdrawn account.

The client of the transaction determines its success or failure (commit or abort) based on values returned from the method call that caused the transaction to complete. The client can be either a base client or another MTS object that exists outside the transaction. The client must know which methods cause transactions to complete and how the method output values can be used to determine success (commit) or failure (abort).

An object method that intends to commit a transaction typically returns an HRESULT value of S_OK after calling SetComplete. On return, MTS automatically completes the transaction. If the transaction commits, the S_OK value is returned to the client. If it aborts, the HRESULT value is changed to CONTEXT_E_ABORTED. The client can use these two values to determine the outcome.

An object method typically notifies its client that it has forced the transaction to abort by calling SetAbort in one of two ways:

•	Return S_OK and use an output parameter to indicate the failure.

•	Return an HRESULT error code. Different codes could be used to distinguish different causes, or the generic CONTEXT_E_ABORTED error could be used.

For example, the Sample Bank application uses an output parameter to indicate failure:

Public Function Perform(lngPrimeAccount As Long, _

   lngSecondAccount As Long, lngAmount As Long, _

   strTranType As String, ByRef strResult As String) _

   As Long

' get our object context

Dim ctxObject As ObjectContext

Set ctxObject = GetObjectContext()

On Error GoTo ErrorHandler

' check for security

If (lngAmount > 500 Or lngAmount < -500) Then

    If Not ctxObject.IsCallerInRole("Managers") Then

        Err.Raise Number:=ERROR_NUMBER, _

        Description:="Need 'Managers' role " + _

           "for amounts over $500"

    End If

End If

.

.

.

ctxObject.SetComplete       ' we are finished and happy

Perform = 0

Exit Function

ErrorHandler:

ctxObject.SetAbort           ' we are unhappy

strResult = Err.Description  ' return the error message

Perform = -1           ' indicate that an error occured

End Function

It is also important to note that there are failure scenarios where the client cannot determine the transaction outcome. This situation results, for example, when a call failure occurs due to a transport error such as RPC_E_CONNECTION_TERMINATED). In such cases, it is necessary to use an application-defined protocol to determine the transaction outcome.

On clustered servers, MTS will not automatically reconnect to MS DTC in the event of a failover. Not enough information exists about the transaction composition and state to determine the appropriate course of action. Retries remain the responsibility of the client application. The client cannot differentiate an error caused by failover from other errors.

Resource managers are guaranteed to get transaction outcomes as part of the two-phase commit protocol managed by the Microsoft Distributed Transaction Coordinator. This feature allows resource managers to manage locks and to determine whether it is necessary to make state changes permanent or to discard them.


MTS Objects

An MTS object is an instance of an MTS component. MTS maintains context for each object. This context, which is implicitly associated with the object, contains information about the object's execution environment, such as the identity of the object's creator and, optionally, the transaction encompassing the work of the object. The object context is similar in concept to the process context that an operating system maintains for an executing program.

An MTS object and its associated context object

An MTS object and its associated context object have corresponding lifetimes. MTS creates the context before it creates the MTS object. MTS destroys the context after it destroys the MTS object.

See Also

Application Components, MTS Component Requirements, Context Objects, asconCreatingTransactionServerObjects, Passing Object References, Deactivating Objects


Context Objects

Each MTS object has an associated context object. A context object is an extensible MTS object that provides context for the execution of an instance, including transaction, activity, and security properties. When an MTS object is created, MTS automatically creates a context object for it. When the MTS object is released, MTS automatically releases the context object.

An MTS object and its associated context object

An MTS object's context has intrinsic properties that are determined during object creation. These properties include the identity of the client that initiated the object's creation and whether or not the object executes within the scope of a transaction.

The properties established for the new object context are determined by a combination of:

•	The transaction attributes of the component as specified in the MTS catalog.

•	The properties of the context from which the new object is created. For example, the client's context may contain a transaction.

If your application uses Microsoft Internet Information Server (IIS), you can retrieve IIS intrinsic objects as follows:

•	Using Visual Basic, by calling the Item method of the context object.

•	Using Microsoft Visual C++ or Microsoft Visual J++, by calling the GetProperty method of the IGetContextProperties interface.

For more information on IIS intrinsic objects, see the IIS documentation.

Contexts Are Implicit

MTS maintains an implicit relationship between an MTS object and its context. This feature eliminates the need for you to pass explicitly a context object through your application.

You can access an MTS object's context by calling the GetObjectContext function. This function returns a reference to the IObjectContext interface. Resource dispensers and other context-aware services can also access the object's context. This permits the ODBC resource dispenser automatically to enlist connections on the object's transaction.

Before a method of an MTS object is dispatched for execution, that object's context becomes the current context for the thread. This context remains current as long as the object remains within the context. Calling a method in a different context causes that context to become current; the caller's context is automatically restored on return from the method.

Managing References to the Context Object

You must not pass a reference to the context object outside the object. You must explicitly release every reference that you acquire on the object context.

The context object is not available during calls to the component's class factory. This means, for example, that a Visual C++ class implementation cannot access a context object during calls to a constructor or destructor. Objects that require access to the context object during initialization or destruction should implement IObjectControl. For more information, see Deactivating Objects.

See Also

MTS Objects, GetObjectContext, IObjectContext


Creating MTS Objects

You can create MTS objects by:

•	Using context objects.

•	Using transaction context objects.

•	Using standard COM functions like CoCreateInstance or CreateObject.

Note   If you are using Visual C++ and running an MTS component in-process, you must:

•	Call CoInitialize(NULL) before requesting services from MTS or creating an MTS object.

•	Call CoInitializeSecurity to initialize process-specific security. MTS security is disabled when loading an MTS object in-process.

•	Call CoUninitialize only after you have finished using MTS or MTS objects, preferably just prior to terminating your application. You cannot call CoInitialize again and invoke more MTS services. Once CoUninitialize has been called, your application no longer executes in the MTS run-time environment.

Creating Objects Using a Context Object

You can create an MTS object by calling the CreateInstance method on the IObjectContext interface of an object's context object. The new MTS object's context inherits the activity, possibly a transaction, and all security identities from the creating object's context.

Creating an object using a context object

Creating Objects Using a Transaction Context Object

If you want your base client to control transaction boundaries, use a transaction context object. You can create an MTS object by calling the CreateInstance method of the ITransactionContext interface. The new MTS object's context inherits the activity, possibly a transaction, and the identity of the initial client from the transaction context object. You can call the Commit method to commit an object's work and the Abort method to abort its work.

Creating an object using a transaction context object

Creating Objects Using CoCreateInstance

You can create MTS objects by using CoCreateInstance or any equivalent method based on CoGetClassObject and IClassFactory::CreateInstance. While this approach should suffice for many base client applications, there are some significant limitations for the client, including the inability to control transaction boundaries. Base clients that need this additional level of control can use a transaction context object.

Instantiating an object with CoCreateInstance

When you use CoGetClassObject with a component that is registered to run under MTS, it returns a reference to an MTS-provided class factory. This allows MTS to participate in the client's calls to IClassFactory::CreateInstance. The MTS class factory creates the context object and then calls the component's real class factory.

For clustered servers, if you are using the CoCreateInstanceEx function, use the name of the virtual server containing the MSDTC resource in the pwszName field of the COSERVERINFO structure. (See the Microsoft Platform SDK documentation for more details about CoCreateInstanceEx.)

Important It is recommended that you do not call CoCreateInstance to create MTS objects from within MTS objects. When you do so, the new object's context cannot inherit any properties from its client's context. In particular, the new object cannot execute within the scope of its client's transaction.

Aggregation

You cannot use an MTS object as part of an aggregate of other objects. CoCreateInstance returns CLASS_E_NOAGGREGATION to indicate an attempt to create an MTS object with another controlling IUnknown.

You can, however, create an MTS object that is implemented as an aggregation of objects.

Creating Objects Using Visual Basic

You can use the following object creation methods in Microsoft Visual Basic to create MTS objects:

•	The CreateObject function

•	The GetObject function

•	The New keyword (see the Important note for limitations)

•	Automatically if the object is an Application object

Using Visual Basic object creation methods results in the same limitations as using CoCreateInstance. To inherit a transaction from the creating object's context, use CreateInstance.

Important   Do not use the New operator, or a variable declared As New, to create an instance of a class that is part of the active project. In this situation, Visual Basic uses an implementation of object creation that does not use COM. To prevent this occurrence, it is recommended that you mark all objects passed out from a Visual Basic componentas Public Creatable, or its equivalent, and created with either the CreateObject function or the CreateInstance method of the ObjectContext object.

See Also

MTS Objects, Calling MTS Components, Context Objects, Passing Object References, Deactivating Objects, CreateInstance


Transaction Context Objects

The transaction context object allows base clients to combine the work of multiple MTS objects into a single transaction, without having to develop a new component specifically for that purpose.

The transaction context object's methods use its context object as follows:

•	CreateInstance — Calls CreateInstance and returns a reference to the newly created object.

•	Commit — Calls SetComplete and returns.

•	Abort — Calls SetAbort and returns.

The transaction context component is defined as Requires a New Transaction. You cannot use the transaction context object to enlist in an existing transaction.

For example, suppose you have two components, Walk and ChewGum. Each component is defined as Supports Transactions and calls SetComplete when it is finished with its work. A base client could compose the work done by each component in a single transaction.

Dim objTxCtx As TransactionContext

Dim objWalk As MyApp.Walk

Dim objChewGum As MyApp.ChewGum

' Get TransactionContext

Set objTxCtx = _

CreateObject("TxCtx.TransactionContext")

' Create instances of Walk and ChewGum

Set objWalk = _

objTxCtx.CreateInstance("MyApp.Walk")

Set objChewGum = _

objTxCtx.CreateInstance("MyApp.ChewGum")

' Both components do work

objWalk.Walk

objChewGum.ChewGum

' Commit the transaction

objTxCtx.Commit

Transaction Context Object Limitations

Note the following limitations when using a transaction context object:

•	Transaction composition

•	Location transparency

•	Base client does not have context

Transaction Composition

When using a transaction context object, the application logic that composes the work into a single transaction is tied to a specific base client implementation and the advantages of using MTS components are lost. These implementations include:

•	Ability to reuse the application logic as part of an even larger transaction

•	Imposition of declarative security

•	Flexibility to run the logic remotely from the client

Location Transparency

The transaction context object runs in-process with the base client, which means that MTS must exist on the base client computer. This may not be a problem, for example when the transaction context object is used from an Active Server Page (ASP) that is running on the same server as MTS.

Base Client Does Not Have Context

You do not get a context for the base client when you create a transaction context object. Transactional work can only be done indirectly, through MTS objects created by using the transaction context object. In particular, the base client cannot use MTS resource dispensers (such as ODBC) and have the work included in of the transaction. For example, developers may be familiar with the following syntax for doing transactional work on relational database systems:

BEGIN TRANSACTION

DoWork

COMMIT TRANSACTION

Using the transaction context object in a similar way does not yield the desired result:

Set objTxCtx = CreateObject("TxCtx.TransactionContext")

DoWork

objTxCtx.Commit

Set objTxCtx = Nothing

The call to DoWork in this example will not be enlisted in a transaction. You must build an MTS component that calls DoWork, create an object instance of that component using the transaction context object, then call that object from the base client in order for the work to be part of the client-controlled transaction.

See Also

Transactions, TransactionContext Object


Passing Parameters

This topic covers the following:

•	Parameter types and marshaling

•	Objects as parameters

•	Passing large data

Parameter Types and Marshaling

MTS object interfaces must be able to be marshaled. Marshaling interfaces allows calls across thread, process, and machine boundaries.

Standard COM marshaling is used. This means MTS object interfaces must either:

•	Have method parameters which are Automation data types and be described in a type library, or

•	Use custom interfaces with a MIDL-generated proxy-stub DLL.

For more information on type libraries and proxy-stub DLLs, see MTS Component Requirements.

Custom marshaling is not used. Even if a component supports the IMarshal interface, its IMarshal methods are never called by the MTS run-time environment.

VBScript Parameters

Components that are intended for use from Active Server Pages (ASPs) using Microsoft Visual Basic® Scripting Edition (VBScript) should support IDispatch and limit method parameter types as follows:

•	VBScript version 1.0—Any Automation type may be passed by value, but not by reference. Method return values must be of type Variant.

•	VBScript version 2.0—Same as VBScript version 1.0, except parameters of type Variant may now be passed by reference.

Objects as Parameters

Whether an object is passed by value or by reference is not specified by the client, but is a characteristic of the object itself. Basic COM objects can either be passed by reference or by value, depending on their implementation. If the COM object uses standard marshaling, then it is passed by reference. COM objects can also implement IMarshal to copy data by value. MTS objects are always passed by reference.

Additionally, the function of the object affects how it should be passed as a parameter. When deciding whether to pass objects by value or by reference, it is useful to classify the objects as follows:

•	Recordset Objects—Encapsulate raw data, such an ADO recordset. Recordset objects are not registered as MTS objects.

•	Business Object—Encapsulate business logic; for example, an order-processing component. Business objects should be registered as MTS objects.

The following table describes when to pass recordset objects by value or by reference:

Pass Parameter	If	Client Requirements
By value	Data is relatively small	Recipient requires all data and can get data without reaccessing caller.
By reference	Data is relatively large	Recipient does not require all data and must reaccess caller, possibly many times.
Note   Whether data is "small" or "large" also depends on the speed of the connection. For example, if the component is accessed over a corporate intranet, a much larger recordset can be passed to the client in one call than in a call made by a client accessing the component on an Internet server over a modem.

Because business objects are MTS objects, they are always passed by reference.

Passing Large Data

When returning a large amount of data, consider using a Microsoft Active Data Objects (ADO) Recordset object. In particular, the Microsoft Advanced Data Connector (ADC) provides a recordset implementation that can be disconnected from the server and marshaled by value to the client.

The disconnected recordset moves state to the client, allowing server resources to be freed. The client can make changes to the recordset and reconnect to the server to submit updates. For more information on state, see Holding State in Objects.

Another method of packaging large amounts of data is to use safe arrays. For example, when using Microsoft Remote Data Objects (RDO), you can use the rdoResultSet.GetRows method to copy rows into an array, and then pass the array back to the client. This requires fewer calls and is more efficient than issuing MoveNext calls across the network for each row.


Passing Object References

You must ensure that MTS object references are only exchanged in the following ways:

•	Through return from an object creation interface, such as CoCreateInstance (or its equivalent), ITransactionContext::CreateInstance, or IObjectContext::CreateInstance.

•	Through a call to QueryInterface.

•	Through a method that has called SafeRef to obtain the object reference.

An object reference that is obtained in these ways is called a safe reference. MTS ensures that methods invoked using safe references execute within the correct context.

Using SafeRef to pass a reference to an object

Note   It is not safe to exchange references by any other means. In particular, do not pass interfaces outside the object by using global variables. These restrictions are similar to those imposed by COM for references passed between apartments.

Calls that use safe references always pass through the MTS run-time environment. This allows MTS to manage context switches and allows MTS objects to have lifetimes that are independent of client references. For more information, see Deactivating Objects.

Callbacks

It is possible to make callbacks to clients and to other MTS components. For example, you can have an object that creates another object. The creating object can pass a reference to itself to the created object; the created object can then use this reference to call the creating object.

If you choose to use callbacks, note the following restrictions:

•	Calling back to the base client or another package requires Access-level security on the client. Additionally, the client must be a DCOM server.

•	Intervening firewalls may block calls back to the client.

•	Work done on the callback executes in the environment of the object being called. It may be part of the same transaction, a different transaction, or no transaction.

•	The creating object must call SafeRef and pass the returned reference to the created object in order to call back to itself.

See Also

SafeRef


Deactivating Objects

MTS extends COM to allow object deactivation, even while client references are maintained. This makes server applications more scalable by allowing server resources to be used more efficiently.

MTS objects are initially created in the deactivated state. When a client invokes a method on an object that is in a deactivated state, MTS automatically activates the object. During activation, the object is put into its initial state.

Note   For Visual C++ developers, calls to QueryInterface, AddRef, or Release do not cause activation.

This ability for an object to be deactivated and reactivated while clients hold references to it is called just-in-time activation. From the client's perspective, only a single instance of the object exists from the time the client creates it to the time it is finally released. In actuality, it is possible that the object has been deactivated and reactivated many times.

Just-in-time activation

The context object exists for the entire lifetime of its MTS object, even across one or more deactivation and reactivation cycles.

Object deactivation allows clients to hold references for long periods of time with limited consumption of server resources. Consider, for example, a client application that spends 99 percent of its time between transactions. In this case, the MTS objects are activated less than 1 percent of the time.

When is an object deactivated?

An MTS object is deactivated when any of the following occurs:

•	The object requests deactivation.

An object can request deactivation by using the IObjectContext interface. You can use the SetComplete method to indicate that the object has successfully completed its work and that the internal object state doesn't need to be retained for the next call from the client. Similarly, SetAbort indicates that the object cannot successfully complete its work and that its state does not need to be retained.

You can develop stateless objects by using MTS objects that deactivate on return from every method.

•	A transaction is committed or aborted.

MTS does not allow an object to maintain private state that it acquired during a transaction. When an object's transaction is committed or aborted, the object is deactivated. Of these deactivated objects, the only ones that can continue to exist are the ones that have references from clients outside the transaction. Subsequent calls to these objects reactivate them and cause them to execute in the next transaction.

•	The last client releases the object.

This occurrence is listed here for completeness. The object is deactivated and never reactivated. The object's context is also released.

How are objects deactivated?

MTS deactivates an object by releasing all its references to the object. This causes properly developed components to destroy the object; this feature also requires the component to follow the MTS reference passing rules (see Passing Object References) and the COM reference counting rules.

Note   MTS writes an Informational message to the event log when objects that do not report their reference count are deactivated.

Application components are responsible for releasing object resources on deactivation. This includes:

•	Resources that are allocated with MTS resource dispensers, such as ODBC database connections.

•	All other resources, including references to other objects (including MTS objects and context objects) and memory held by any instances of the component, such as using delete this in C++).

Doing Additional Work on Activation and Deactivation

If an object is not already activated and it supports IObjectControl, MTS calls the Activate method prior to initiating the client request. Components can use the Activate method to initialize objects. This is especially important for initialization that requires access to the context object. Here, keep in mind that the context is not available during calls to the component's class factory. Having access to the context object through Activate allows you to pass a reference to the context object to other methods; this reference can then be released in the Deactivate method. The Activate method is also useful for objects that support pooling (see Object Pooling and Recycling).

For objects that support the IObjectControl interface, MTS calls the Deactivate method when it deactivates the object. You can use this method to free resources held by the object. The Deactivate method is also useful for objects that support pooling. Like the Activate method, the Deactivate method has access to the object context.

See Also

Building Scalable Components, Stateful Components, Object Pooling and Recycling, SetComplete, SetAbort, IObjectControl


Object Pooling and Recycling

Objects that support the IObjectControl interface can participate in object recycling and pooling, which can increase the efficiency of activation and deactivation. After MTS calls the Deactivate method, it calls the CanBePooled method, allowing the object to be pooled for reuse. If the object returns TRUE, the object is added to the object pool. Objects that return FALSE or that do notsupport the IObjectControl interface are destroyed.

On activation, MTS uses an object from the pool if one is available. Only if the pool is empty will it use the component's class factory to create a new object.

Components that support object pooling must ensure that an object activated using an object from the pool is indistinguishable to the client from an object that is activated by creating a new object. Component developers must provide the appropriate code in the Activate and Deactivate method implementations to ensure this behavior.

The following table summarizes MTS run-time actions for client call processing.

	IObjectControl implemented by component
	No	Yes
Step 1 Activate the object if needed (just-in-time activation).	Use the component class factory to create an object.	Allocate an object from the pool. If pooling is not supported or the pool is empty, then use the component class factory to create an object.
		Call the object's Activate method.
Step 2 Execute the call.	Call the object method.	Call the object method.
Step 3 Deactivate the object if requested (SetComplete or SetAbort called before return).		Call object's Deactivate method
	Release the last reference held by the MTS run-time environment.	If the system supports pooling, then call CanBePooled. If it returns TRUE, then add the object to the pool. Otherwise, release the last reference held by the MTS run-time environment.
Important   Object pooling and recycling is not available in this release. MTS calls CanBePooled as described here, but no pooling takes place. This forward-compatibility encourages developers to use CanBePooled in their applications now in order to benefit from a future release without having to modify their applications later.

See Also

Deactivating Objects, IObjectControl


MTS Clients

An application or object that uses an MTS object is referred to as a client of the object. It is important to understand that this is a relative term, and describes a relationship with a specific object. For example, when MTS object A uses MTS object B, the object A, while still an object, is also a client.

Clients that run outside the direct control of the MTS run-time environment are referred to as base clients.

Clients and base clients: The Order object is a client of the Payment object

See Also

Base Clients, Base Clients vs. MTS Components


Base Clients

Base clients are the primary consumers of MTS objects, although base clients execute outside of the MTS run-time environment. One common role of a base client is to provide the application's user interface, and to map the end-user's requests to the business functions exposed by the MTS components.

You can create base clients with a variety of programming languages, including Microsoft Visual C++, Microsoft Visual Basic, Microsoft Visual J++, COBOL, and even Transact SQL. Base client programs can execute in a variety of environments, from application processes to general system services such as Microsoft Internet Information Server (IIS) or SQL Server. In fact, you can use any programming environment in which you can create COM objects and invoke methods on them.

See Also

MTS Clients, Base Clients vs. MTS Components


Base Clients vs. MTS Components

The following table contrasts MTS components with base client applications.

MTS components	Base clients
MTS components are contained in COM dynamic-link libraries (DLLs); MTS loads DLLs into processes on demand.	Base clients can be written as executable files (.exe) or dynamic-link libraries (.dll); MTS is not involved in their initiation or loading.
MTS manages server processes that host MTS components.	MTS does not manage base client processes.
MTS creates and manages the threads used by components.	MTS does not create or manage the threads used by base client applications.
Every MTS object has an associated context object. MTS automatically creates, manages, and releases context objects.	Base clients do not have implicit context objects. They can use transaction context objects, but they must explicitly create, manage, and release them.
MTS objects can use resource dispensers. Resource dispensers have access to the context object, allowing acquired resources to be automatically associated with the context.	Base clients cannot use resource dispensers.
See Also

MTS Clients, Application Components


Activities

An activity is a set of objects executing on behalf of a base client application. Every MTS object belongs to one activity. This is an intrinsic property of the object and is recorded in the object's context. The association between an object and an activity cannot be changed. An activity includes the MTS object created by the base client, as well as any MTS objects created by that object and its descendants. These objects can be distributed across one or more processes, executing on one or more computers.

For example, an online banking application may have an MTS object dispatch credit and debit requests to various accounts, each represented by a different object. This dispatch object may use other objects as well, such as a receipt object to record the transaction. This results in several MTS objects that are either directly or indirectly under the control of the base client. These objects all belong to the same activity.

MTS tracks the flow of execution through each activity, preventing inadvertent parallelism from corrupting the application state. This feature results in a single logical thread of execution throughout a potentially distributed collection of objects. By having one logical thread, applications are significantly easier to write.

Whenever you use CoCreateInstance or its equivalent to create an MTS object, a new activity is created; note that this includes a base client creating a transaction context object.

When an MTS object is created from an existing context, using either a transaction context object or an MTS object context, the new object becomes a member of the same activity. In other words, the new context inherits the activity identifier of the context used to create it.

MTS only allows a single logical thread of execution within an activity. This is similar in behavior to a COM apartment, except that the objects can be distributed across multiple processes. When a base client calls into an activity, all other requests for work in the activity (such as from another client thread) are blocked until after the initial thread of execution returns back to the client.

Callbacks and Reentrancy

While MTS does not allow multiple threads of execution within an MTS object, reentrancy is possible via callbacks. Suppose you have an object that creates another object. If the creating object passes a reference to itself to the created object, either directly or indirectly, cycles can occur in the call graph. MTS objects that do this must be prepared to receive a method invocation while blocked waiting for a call to complete. MTS ensures that the incoming call belongs to the same logical thread by using the COM logical thread identifier. COM uses the logical thread identifier for a similar purpose in apartment objects.

Limitation

While no parallel execution can exist within the activity on any individual computer, the MTS run-time environment does not protect against clients entering into the same activity through objects on two different computers. This can result in two parallel threads of execution on different computers. However, if the thread of execution on one computer calls an object in the same activity on the other, the call will be blocked.

This behavior is based on the belief that the cost outweighs the benefits of providing fully distributed activity protection, both in terms of development and run-time performance.

See Also

Components and Threading, Passing Object References


Components and Threading

The MTS run-time environment manages threads for you. MTS components need not, and, in fact, should not, create threads. Components must never terminate a thread that calls into a DLL.

Every MTS component has a ThreadingModel Registry attribute, which you can specify when you develop the component. This attribute determines how the component's objects are assigned to threads for method execution. You can view the threading-model attribute in the MTS Explorer by clicking the Property view in the Components folder. The possible values are Single, Apartment, and Both.

Single-Threaded Components

All objects of a single-threaded component execute on the main thread. This is compatible with the default COM threading model, which is used for components that do not have a ThreadingModel Registry attribute.

The main threading model provides compatibility with COM components that are not reentrant. Because objects always execute on the main thread, method execution is serialized across all objects in the component. In fact, method execution is serialized across all components in a process that uses this policy. This allows components to use libraries that are not reentrant, but it has very limited scalability.

Limitations for Single-Threaded Components

Single-threaded, stateful components are prone to deadlocks. You can eliminate this problem by using stateless objects and calling SetComplete before returning from any method.

The following scenario describes how such a deadlock can occur. Suppose you have a single-threaded Account component, which is written to be both transactional and stateful. The following scenario describes how two clients, Client 1 and Client 2, could call objects in a way that causes an application deadlock:

•	Client 1 creates Account object A and calls it to update an account record. The database update is done under object A's transaction (Transaction 1). Because the object does not call SetComplete before returning to the client, Transaction 1 remains active.

•	Next, Client 2 creates Account object B and calls it to update the same account. Because its work is done under a different transaction (Transaction 2), the attempt to update the account record will block while waiting for Transaction 1 to complete.

•	Client 1 makes another call to object A, for instance, to have it make another change to the account record and complete the transaction. However, the call must wait for the main thread, which is still busy servicing the call from Client 2.

•	The two clients are now deadlocked. Client 1 holds a lock on the account record, while waiting for the server's main thread so that it can complete Transaction 1. Client 2 holds the server's main thread, while waiting for Transaction 1 to complete so that it can update the account record.

Note that this is not a deadlock from the SQL perspective because A's and B's connections are in different transactions.

Apartment-Threaded Components

Each object of an apartment-threaded component is assigned to a thread its apartment, for the life of the object; however, multiple threads  can be used for multiple objects. This is a standard COM concurrency model. Each apartment is tied to a specific thread and has a Windows message pump.

The apartment threading model provides significant concurrency improvements over the main threading model. Activities determine apartment boundaries; two objects can execute concurrently as long as they are in different activities. These objects may be in the same component or in different components.

See Also

Activities


Programmatic Security

The MTS security model consists of declarative security and programmatic security. Developers can build both declarative and programmatic security into their components prior to deploying them on a Windows NT security domain.

Important   Security is not supported on Windows 95. Note the following application behavior when running MTS on Windows 95:

•	All identities are mapped to "Windows 95".

•	Role configuration is not supported.

•	Checking roles always return success.

Roles are central to the MTS security model. A role is an abstraction that defines a logical group of users. At development time, you use roles to define declarative authorization and programmatic security logic. At deployment time, you bind these roles to specific groups and users.

You can administer package security with the MTS Explorer. This is a form of declarative security, which does no't require any component programming is based on standard Windows NT security.

MTS also allows component applications to implement additional access control programmatically. MTS security is integrated with DCOM and Windows NT security. See the Microsoft Platform SDK for further information on COM security APIs.

See Also

Basic Security Methods, Advanced Security Methods


Basic Security Methods

The IObjectContext interface provides two methods for basic programmatic security:

•	IsCallerInRole

•	IsSecurityEnabled

The key to understanding how MTS security works is to understand roles, as discussed in the following sections.

Roles from a Development Perspective

A role is a symbolic name that defines a logical group of users for a package of components. For example, an online banking application might define roles for Manager and Teller.

You can define authorization for each component and component interface by assigning roles. For example, in the online banking application, only the Manager may be authorized to perform bank transactions above a certain amount of money.

Roles are defined during application development. These roles are then assigned to specific users at deployment time.

Important   Roles on a dual interface are not enforced when IDispatch (late-binding) is used.

Checking If a Caller Is in a Role

The IsCallerInRole method determines if a caller is assigned to a role. The caller is the direct caller, which is the identity of the process (base client or server process) calling into the current server process.

The following illustration shows an application used to order supplies for a business.

You can use roles to determine whether the base client has access to objects in the server process. In this scenario, the server process would check to see if the base client is allowed to place an order. Calling IsCallerInRole on the Order object context checks if the direct caller, which is in this case the base client, is in a given role. Such a role might be Purchaser, to restrict the placing of orders to employees within that role.

Security checks are made when a process boundary is crossed. If the Payment object accesses a database, the access rights to the database are derived from the identity of the server process, not the base client. The database would use its own proprietary authorization checking.

Server-process security does not use impersonation. IsCallerInRole has the same semantics regardless of how many calls have taken place within the server process. The identity of the direct caller is always used to make the check. For more information on impersonation, see Advanced Security Methods.

Security for In-Process Components

Because the level of trust is process-wide, running MTS components in-process is not recommended for secure applications. Access checks are not made on calls between components in the same server process. Configuring MTS components to run in-process with the base client gives the base client access to all components within that server process.

The IsSecurityEnabled method determines if security checking is enabled. This method returns FALSE when running in-process. IsSecurityEnabled can be a useful check to make before using IsCallerInRole. IsCallerInRole will always return TRUE when called on an object that is running in-process, which may have unintended effects.

When an MTS component is part of a Library package (in-process), it effectively becomes part of the hosting Server package that creates it. If you create Library packages with components that call IsCallerInRole, you should instruct installers of your Library packages to define the Library package's roles on the hosting Server package. Otherwise, IsCallerInRole will always fail.

See Also

IsCallerInRole, IsSecurityEnabled, Secured Components


Advanced Security Methods

MTS objects can use the ISecurityProperty interface to obtain security-related information from the object context, including the identity of the client that created the object, as well as the identity of the current calling client. Applications can use this information to implement custom access control, such as using the Win32 security interfaces.

Note   Visual Basic programmers can use the SecurityProperty object. The methods for SecurityProperty return user name strings instead of security identifiers (SIDs).

Security Identifiers (SIDs)

A Windows NT security identifier (SID) is a unique value that identifies a user or group. You can use SIDs to determine the exact identity of a user. Because of their uniqueness, SIDs do not have the flexibility of roles.

Callers and Creators

The following figure shows which SIDs are returned by the various methods on ISecurityProperty after a certain sequence of method calls.

Calling the following methods on Object Y returns SIDs associated with these users:

•	GetDirectCallerSID returns the SID associated with User B.

•	GetDirectCreatorSID returns the SID associated with User B.

•	GetOriginalCallerSID returns the SID associated with User D.

•	GetOriginalCreatorSID returns the SID associated with User A.

Impersonation

Impersonation allows a thread to execute in a security context different from that of the process that owns the thread. Consider the following application scenario.

Basic Security Methods described an order-entry scenario in which the base client represents an employee submitting an order. In this scenario, the client is not authorized to use the Payment object and its associated database directly.

Suppose the base client were a report writer for an accounting program. In this case, you want to allow access to the Payment object's database. One way to accomplish this is for the Order object to impersonate the base client, allowing the database to use its own security checking to determine access privileges.

MTS does not promote the use of impersonation, but encourages role-based security. Security is simplified by the single-level of authorization provided by MTS, whereas the impersonation model has an n-level authorization architecture. The report-writer scenario can be simplified by defining a role, such as Accountant, to allow access to the database.


Error Handling

Fault Isolation and Failfast

MTS performs extensive internal integrity and consistency checks. If MTS encounters an unexpected internal error condition, it immediately terminates the process. This policy, called failfast, facilitates fault containment and results in more reliable and robust systems.

Consider a case in which MTS detects that one of its data structures is in a corrupted state. At this point, both the cause and the magnitude of the corruption are unknown. Unfortunately, MTS cannot tell how far the damage has spread. Certainly MTS is in an indeterminate state. But it does not run in isolation. Like other DLLs, it is hosted in a process environment and shares a single address space with the main program executable and many other DLLs. Consequently, it is safe to assume that the entire process has been corrupted. The process is immediately terminated to prevent it from spreading potentially corrupted information to other processes or, worse yet, from allowing corrupted data to be committed and made durable.

As a developer or administrator, you should inspect the Windows NT Event Viewer Application Log for details on any failfast or serious application errors.

Exceptions in MTS Objects

MTS does not allow exceptions to propagate outside of a context. If an exception occurs while executing within an MTS context and the application doesn't catch the exception before returning from the context, MTS catches the exception and terminates the process. Using the failfast policy in this case is based on the assumption that the exception has put the process into an indeterminate state—it is not safe to continue processing.

MTS Object Method Error Return Codes

MTS never changes the value of an HRESULT error code, such as E_UNEXPECTED or E_FAIL, returned by an MTS object method.

When an MTS object returns an HRESULT status code, such as S_OK or S_FALSE, MTS may convert the status code into an MTS error code before it returns to the caller. This occurs, for example, when the application returns S_OK after calling SetComplete; if the object is the root of an automatic transaction that fails to commit, the HRESULT is converted to CONTEXT_E_ABORTED.

When MTS converts a status code to an error code, it clears all of the method's output parameters. Returned references are released and the values of the returned object pointers are set to NULL.

See Also

MTS Error Diagnosis, MTS Error Codes


Developing Applications for MTS

Building MTS Applications

Explains the key concepts that a component application developer needs to understand for developing Microsoft Transaction Server (MTS) applications.

Creating a Simple ActiveX Component

Demonstrates how to create a component and register the component in the Microsoft Transaction Server run-time environment.

Building Scalable Components

Demonstrates how to use just-in-time activation to use server resources efficiently, resulting in more scalable applications and improved performance.

Building Transactional Components

Introduces transactional components and the benefits of running components within the same transaction.

Sharing State

Demonstrates how to use the Shared Property Manager to share state among multiple Transaction Server objects running in the same process.

Stateful Components

Discusses stateful components and outlines some of the issues associated with writing stateful application components.

Multiple Transactions

Explains the benefits of distributing work among multiple transactions.

Secured Components

Shows how to use Microsoft Transaction Server's security features to restrict the use of application features to designated users.


Building MTS Applications

This topic contains information that a component application developer needs to understand before building Microsoft Transaction Server (MTS) applications.

MTS Component Requirements

Business Logic in MTS Components

Packaging MTS Components

Calling MTS Components

Holding State in Objects

Database Access Interfaces with MTS

Developing MTS Components with Java

Debugging MTS Components

Automating MTS Deployment

MTS Error Diagnosis


MTS Component Requirements

An MTS component is a type of COM component that executes in the MTS run-time environment. In addition to the COM requirements, MTS requires that the component must be a dynamic-link library (DLL). Components that are implemented as executable files (.exe files) cannot execute in the MTS run-time environment. For example, if you build a Remote Automation server executable file with Microsoft Visual Basic, you must rebuild it as a DLL.

Additional Requirements for Visual C++ Components

•	The component must have a standard class factory.

The component DLL must implement and export the standard DllGetClassObject function and support the IClassFactory interface. MTS uses this interface to create objects. IClassFactory::CreateInstance must return a unique instance of an MTS object.

•	The component must only export interfaces that use standard marshaling. For more information, see Passing Parameters.

•	All component interfaces and coclasses must be described by a type library. The information in the type library is used by the MTS Explorer to extract information about the installed components.

•	For custom interfaces that cannot be marshaled using standard Automation support, you must build the proxy-stub DLL with MIDL version 3.00.44 or later (provided with in the Microsoft Platform SDK for Windows NT version 4.0); use the  –Oicf compiler switch; and link the DLL with the mtxih.lib library provided by MTS. The mtxih.lib library must be the first file that you link into your proxy-stub DLL. If the component has both a type library and a proxy-stub DLL, MTS will use the proxy-stub DLL.

•	The component must export the DllRegisterServer function and perform self-registration of its CLSID, ProgID, interfaces, and type library in this routine.

Development tools such as Visual Basic and the ActiveX™ Template Library, which is available with Microsoft Visual C++, allow you to generate interfaces that COM can marshal automatically. These interfaces, known as dual interfaces, are derived from IDispatch and use the built-in Automation marshaling support.

Registering MTS Components

You manage MTS components by using the MTS Explorer. Before a component can run with context in the MTS run-time environment, you must use the MTS Explorer to define the component in the MTS catalog. In addition to keeping track of a component's basic COM attributes, such as the name of the implementation DLL, the MTS catalog maintains a set of MTS–specific attributes. MTS uses these attributes to provide capabilities in addition to those provided by COM. For example, the transaction attribute controls the transactional characteristics of a component.

The MTS Explorer assigns components to a package that controls the assignment of components to server processes and control client access to components.

Note   MTS allows only a single server process associated with a given package to run on a computer at a time. MTS writes a warning event message to the log if you attempt to start a second instance of an already active package. However, COM does not explicitly disallow multiple servers running the same COM classes. MTS writes a warning message to the log in the event that two threads try to start the package at the same time. This event is especially likely on a symmetric multiprocessing (SMP) computer where the two package invocations are concurrent. In these cases, MTS enforces a rule of one server process for each package by terminating one of the extra packages. COM then connects to the one server process still running and successfully returns.

Running COM Components Under MTS

Exercise caution when registering a standard COM component (one developed without regard to MTS) to execute under MTS control.

First, ensure that references are safely passed between contexts (see Passing Object References).

Second, if the component uses other components, consider running them under MTS. Rewrite the code for creating objects in these components to use CreateInstance (see Creating MTS Objects).

Third, you can effectively use automatic transactions only with components that indicate the completion of their work by calling either the SetComplete or SetAbort methods. If a component does not use these methods, an automatic transaction can only be completed when the client releases the object. MTS will attempt to commit the transaction, but there is no way for the client to determine whether the transaction has been  committed or aborted. Therefore, it is recommended that you do not register components as Requires a transaction or Requires a new transaction unless they use SetComplete and SetAbort.

Including Multiple Components in DLLs

You can implement multiple components in the same DLL. The MTS Explorer allows components from the same DLL to be installed in separate packages.

Including Type Libraries and Proxy-Stub DLLs in MTS Components

Development tools supporting ActiveX components can merge your type library or proxy-stub DLL with your implementation DLL. If you do not want to distribute your implementation DLL to client computers, keep your type libraries and proxy-stub DLLs separate from your implementation DLLs. The client only needs a type library or custom proxy-stub DLL to use your server application remotely.


Business Logic in MTS Components

This topic describes how to enact business logic in MTS components.

Granularity is determined by the number of tasks performed by a component. The granularity of a component affects the performance, debugging, and reusability of your MTS components. A fine-grained component performs a single task, such as calculating tax on a sales order. Fine-grained components consume and release resources quickly after completing a task. A component that enacts a single business rule can facilitate testing packages, because isolating individual tasks in components makes testing your applications easier. In addition, fine-grained components are easily reused in other packages. In the following example, a component performs a single task: adding a customer record to the database.

Function Update(ByVal strEmail As String, _

ByVal bNewCust As Boolean, ByVal strContact As String,_

ByVal strPhoneNumber As String, _

ByVal strNightPhoneNumber As String)

    Dim ctxObject As ObjectContext

    Set ctxObject = GetObjectContext

    On Error GoTo ErrorHandler

' Code accesses the customer row from the database.

' Customer information is updated with information

' that was passed in.

'

    ctxObject.SetComplete

    Exit Function

This simple component uses system resources efficiently (passing parameters by value), is easy to debug (single function), and also reusable in any other application that maintains customer data.

A coarse-grained component performs multiple tasks. Coarse-grained components are generally harder to debug and reuse in applications. For example, a PlaceOrder component might add a new order, update inventory, and update customer information. PlaceOrder is a more coarsely grained component because it performs more "work" by adding, updating, and deleting customer, inventory and order information.

For more information about components' shared resources, see Holding State in Objects.


Packaging MTS Components

This document describes how you should package your MTS components. Consider the following design issues when defining package boundaries:

•	Activation

•	Shared resources

•	Fault isolation

•	Security isolation

Activation

You can select either of the following Activation levels for your packages:

•	Library (running within the same process as the client that creates the object)

•	Server (on the same computer but in a different process)

MTS provides a way to set up remote components by using the Remote Computer and Remote Component folders in the MTS Explorer hierarchy. For more information about "pulling" or "pushing" components between computers, see the Administrator's Guide.

By default, components run in a server process on the local computer. If you run your components within the MTS server process, you enable resource sharing, security, and easier administration by using the MTS Explorer for your component. Running components in-process provides an immediate performance benefit, because you do not have to marshal parameters cross-process. However, in-process components do not support declarative security and you lose fault isolation.

Sidebar: In-process Components and Security

Note that in-process components do not support declarative security or offer the benefits of process isolation. In-process components will run in any process that creates the component. Role checking is disabled between in-process components because IsCallerInRole returns True. In other words, the direct caller always passes the authorization check.

Also, it is recommended that you place your components as close as possible to the data source. If you are building a distributed application with a number of packages running on local and remote servers, try to group your components according to the location of your data. For example, in the following figure, the Accounting server hosts an Accounting package and Accounting database.

Shared Resources

Sharing resources in a multiuser environment results in faster applications that scale more easily. Note that only components marked with the Local activation setting can share resources. Package your components to take advantage of the resource sharing and pooling that MTS provides for your application.

Pool your resources by server process.Note that MTS runs each hosted package in a separate server process. The fewer pools you have running on your server, the more efficiently you pool resources, so  try to group components that share "expensive" resources, such as connections to a specific database. If you reuse the expensive resources within your package, you can greatly improve the performance and scaling of your application. For example, if you have a database lookup and a database update component running in a customer maintenance application, package those components together so that they can share database connections.

Fault Isolation

Fault isolation requires separating components into packages that can operate in their own server process. Components in the same package share the same server process if all the activation settings are the same. By placing components in separate packages, you can mitigate the impact of a component failure because each package runs in a separate server process.

You can also use fault isolation to test new components. You can stage updates to MTS applications by introducing new components. Fault isolation for packages greatly reduces the risk of your local server package failing when you introduce a new component to a shared environment.

Security Isolation

MTS security roles represent a logical group of user accounts which are mapped to Microsoft Windows NT® domain users and groups during the deployment of the package. You can use the MTS Explorer to define declarative authorization checking by applying roles to components and component interfaces. Applying a security role to a component defines access privileges for any user assigned as a member of that security role. Users not assigned to a role with access privileges to a package cannot use the package. Because security authorization occurs between packages rather than between components within a package, it is recommended that you consider the MTS security model when determining your package boundaries. Note that security isolation only applies to packages with components running under the Server activation setting.

Security authorization is checked when a method call crosses a package boundary, such as when a client calls into a package or one package calls another. When you package your components, make sure you group components that can safely call each other without requiring security checks within one package.

All components within a package run under the identity established for the package. If you run under different identities, separate them into two different packages.

You can use declarative security between the client and server, and database security based on package identity between the server and data source. You can restrict access to a data source by assigning an identity to a package, and configuring the database to accept updates according to package identity.

If you use package identity to set up your database security, the database recognizes the package identity as a single user. If database access occurs under an identity set by the package, the database connection set up for the package identity name can be used by all the users mapped to role or roles for that package. This kind of resource sharing improves application performance and scalability.


Calling MTS Components

This topic covers the following:

•	Calling MTS Components using DCOM

•	Calling MTS Components from an Active Server Page

•	Calling MTS Components from a Web Browser-Resident Component

For more information on the methods for creating MTS objects, see Creating MTS Objects.

Calling MTS Components from a Client Application

MTS components can be located on a separate computer from the client. A client can call a remote MTS component using DCOM, HTTP, or Remote Automation. To run an MTS component on the client computer, the client computer must have MTS installed.

Calling MTS Components through DCOM

DCOM is the standard transport for calling MTS components. To enable DCOM calls to MTS components, you must configure the following:

Client Registry Settings — The easiest way to configure your client application to call a remote MTS component is to use the application executable utility, which automatically configures client registry settings. For more information,see the Administrator's Guide.

DCOM Security Settings — You may have to configure the Impersonation Level and Authentication Level on both client and server computers. MTS works properly using the default values for these settings: Identify for Impersonation Level and Connect for Authentication Level. Make the necessary changes in the MTS Explorer at the package level. Changing default settings by using the DCOM configuration utility (dcomcnfg.exe) is not recommended.

If you want to use Microsoft Windows 95 clients with MTS, install DCOM for Windows® 95. For the latest information on DCOM support for Windows 95, see http://www.microsoft.com/oledev on the World Wide Web.

Calling MTS Components through Remote Automation

Remote Automation was introduced with Visual Basic version 4.0, before the introduction of DCOM. It is useful for 16-bit clients, because DCOM works only in 32-bit environments. To use Remote Automation with MTS, the Remote Automation Manager (RACMAN) must be running on the server where the MTS components are installed. For more information, see the Visual Basic documentation.

Note   You cannot use MTS security Remote Automation since all calls are made using the RACMAN identity. Because RACMAN does not impersonate when calling the components on the server, the client identity cannot be determined.

Calling MTS Components through HTTP

There are two ways a client can call an MTS component through HTTP:

•	Call an Active Server Page (ASP), which in turn calls the MTS component using DCOM.

•	Call the MTS component from a Web browser – resident component using the ActiveX Data Objects (ADO) Remote Data Service (RDS), which in turn uses HTTP. For more information about RDS, see http://www.microsoft.com/adc.

Calling MTS Components from an Active Server Page

You can call MTS components from Active Server Pages (ASPs). You can create an MTS object from an ASP by calling Server.CreateObject. Note that if the MTS component has implemented the OnStartPage and OnEndPage methods, the OnStartPage method is called at this time.

You can run your MTS components in-process with or out-of-process with Internet Information Server (IIS). If you run your MTS components in-process with IIS, be aware that if MTS encounters an unexpected internal error condition or an unhandled application error such as a general-protection fault inside a component method call, it immediately results in a failfast, thus terminating the process and IIS.

By default, IIS 3.0 disables calling out-of-process components. To enable calling out-of-process components, modify the following registry entry

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\ASP\Parameters

by setting the AllowOutOfProcCmpnts key to 1.

Calling MTS Components from a Web Browser-Resident Component

You can call an MTS component from a Web browser – resident component. Use the application executable utility to configure that client, and then use the HTML <OBJECT> tag to call that component. You can also use the <OBJECT> tag to create an MTS object in-process with the browser client. Remember that MTS must be installed on the client computer for an MTS component to run in-process.

The component should be made safe for scripting, either through a component category entry in the registry, or by supporting the IObjectSafety interface.

Remote Data Service (RDS) also allows you to create web browser – resident components using the <OBJECT> tag. RDS supports the following:

•	HTTP

•	HTTPS (HTTP over Secure Socket Layer)

•	DCOM

•	In-process server

Except for in-process objects, the CreateObject method of the DataSpace object creates a proxy for the MTS object that runs in a local or remote server process.

You must configure the following registry key to the Prog ID of the object that you want to call:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ADCLaunch


Holding State in Objects

Although there are many benefits to using stateless MTS objects, there are cases where holding state is desirable. This topic provides some guidelines in deciding where state is held in your application.

The following diagram shows a three-tier architecture:

Typically, the latency between tiers differs greatly. Calls between the presentation tier and business tier are often an order of magnitude slower than calls between the business tier and data tier. As a result, held state is more costly when calling into the business tier.

However, it often makes sense to hold state within the transaction boundary itself. For example, the objects in the data tier may represent a complex join across many tables in separate databases. Reconstructing the data object state is potentially more inefficient than the cost of the resources held by those objects while they remain active.

Since objects lose state on transaction boundaries, if you need to hold state across transactions, use the Shared Property Manager or store the state in a database.

Example: Order-Entry Application

There are two separate issues when considering the effects of holding state in an application:

•	Network roundtrips — More frequent network roundtrips and slower connections extend the lifetime of the called MTS object.

•	Held resources — Holding state often means holding onto a resource, such as a database connection, and potentially, locks on the database.

Consider the example of an online shopping application. The client chooses items from a catalog and submits an order. Order processing is handled by a business object, which in turn stores the order in a database (not shown).

One way of building the application is for the client to call an Order object, with each call adding or removing an item from the order:

This application has the following properties:

•	Client maintains no state.

•	Server maintains state across multiple calls.

•	Many network roundtrips.

•	High contention for resources. The database connection is held for the lifetime of the Order object. This is not a very scalable solution.

You can require that the client cache the items in an array or recordset:

This application has the following properties:

•	Stateful client.

•	Server is virtually stateless with one call to the server.

•	Fewer network roundtrips.

•	Less contention for resources. This is a scalable solution.

Concurrency

In addition to network bandwidth and resources, concurrency affects application performance. There are two types of concurrency:

•	Pessimistic — As soon as editing begins, the database locks the records being changed. The records are unlocked when all changes are complete. No two users can access the same record at the same time.

•	Optimistic — The database locks the records being changed only when the changes are committed. Two users can access the same record at the same time, and the database must be able to reconcile, or simply reject, changed records that have been edited by multiple users prior to commit.

Implementing a server cache implies optimistic concurrency. The server does not have to hold locks on the database, thus freeing resources.

However, if there is high contention for the resource, pessimistic concurrency may be preferred. It is easier to reject a request to access a database and have the server try again than it is to reconcile cached, out-of-date data with a rapidly changing database.


Database Access Interfaces with MTS

This topic describes the database access interface options for MTS applications. You can use the Open Database Connectivity (ODBC) Application Programming Interface (API) to access a resource manager (which is a system service that manages durable data), or a data access model that functions over the ODBC layer. Because the ODBC version 3.0 Driver Manager is an MTS resource dispenser, data accessed via ODBC is automatically protected by your object's transaction. For object transactions, an ODBC-compliant database must support the following:

•	The database's ODBC driver must be thread safe. It also must be able to connect to the driver from one thread, use the connection from another thread, and disconnect from another thread.

•	If ODBC is used from within a transactional component, then the ODBC driver must also support the SQL_ATTR_ENLIST_IN_DTC connection attribute. This is how the ODBC Driver Manager asks the ODBC driver to enlist a connection on a transaction. You can make your component transactional by setting the transaction property for your component in the MTS Explorer. If you are using a database without a resource dispenser that can recognize MTS transactions, contact your database vendor to obtain the required support.

The following table summarizes database requirements for full MTS support.

Requirements	Description	Resources (if applicable)
Support for the OLE transactions specification, or support for XA protocol	Enables direct interaction with Distributed Transaction Coordinator (DTC). Use the XA Mapper to interact with DTC	MTS Beta SDK
ODBC driver	Platform requirement for MTS server components	ODBC version 3.0 SDK
ODBC driver support for the ODBC version 3.0 SetConnectAttr SQL_ATTR_ENLIST_ IN_DTC call.	MTS uses this call to pass the transaction identifier to the ODBC driver. The ODBC driver then passes the transaction identifier to the database engine.	ODBC version 3.0 SDK
Fully thread-safe ODBC driver	ODBC driver must be able to handle concurrent calls from any thread at any time.	ODBC version 3.0 SDK
ODBC driver must not require thread affinity	ODBC driver must be able to connect to the driver from one thread, use the connection from another thread, and disconnect from another thread.	ODBC version 3.0 SDK
If a memory access violation in the mtx.exe process occurs within the driver after 60 seconds of inactivity, you may be using an ODBC driver that is not thread safe or requires thread affinity. The fault occurs in the driver when the inactive connections are being disconnected.

MTS Distributed Transaction Coordinator

MTS uses the services of the Microsoft Distributed Transaction Coordinator (DTC) for transaction coordination. DTC is a system service that coordinates transactions that span multiple resource managers. Work can be committed as a single transaction, even if it spans multiple resource managers, potentially on separate computers. DTC was initially released as part of Microsoft SQL Server version 6.5, and is included as part of MTS. DTC implements a two-phase commit protocol that ensures that the transaction outcome (either commit or abort) is consistent across all resource managers involved in a transaction. DTC supports resource managers that implement OLE Transactions, X/Open XA protocols, and LU 6.2 Sync Level 2.

Choosing your Data Access Model

The following table summarizes commonly used data access models supported by MTS.

Interface	Description
Microsoft ActiveX Data Objects (ADO), Remote Data Service (RDS)	ADO offers one common yet extensible programming model for accessing data. ADO includes the ability to pass query results (Recordsets) between server and client, and the ability to pass updated Recordsets from client to server using RDS.
OLE DB	OLE DB is a low-level interface that provides uniform access to any tabular data source. You cannot call OLE DB interfaces directly from Microsoft® Visual Basic® because OLE DB is a pointer-based interface. A Visual Basic client can access an OLE DB data source through ADO.
Open DataBase Connectivity (ODBC)	ODBC is a recognized standard interface to relational data sources. ODBC is fast and provides a universal interface that is not optimized for any specific data source.
Remote Data Objects (RDO)	RDO is a thin object layer interface to the ODBC API. It is specifically designed to access remote ODBC relational data sources.
The diagram below illustrates how MTS components interact with the different data access interfaces:

ADO is not specifically designed for relational or ISAM databases, but as an object interface to any data source. ADO can access relational databases, ISAM, text, hierarchical, or any type of data source, as long as a data access provider exists. ADO is built around a set of core functions that all data sources are expected to implement. ADO can access native OLE DB data sources, including a specific OLE DB provider that provides access to ODBC drivers. ADO ships with the OLE DB Software Development Kit (SDK).

RDO does have some functionality that is not currently implemented in ADO, including the following:

•	Events on the Engine, Connection, Resultset, and Column objects

•	Asynchronous operations

•	Queries as methods

•	Enhanced batch-mode error and contingency handling

•	Tight integration with Visual Basic, as in the Query Connection designer and TSQL debugger.

Future versions of ADO will provide a superset of RDO version 2.0 functionality and provide a far more sophisticated interface, in addition to an easier programming model. Because ADO is an Automation-based component, any application or language capable of working with Automation objects can use it.


Developing MTS Components with Java

You can develop Java MTS components using tools provided by MTS and Visual J++. It is also recommended that you install the latest version of the Microsoft SDK for Java, available at http://www.microsoft.com/java.

This section contains the following topics:

•	Implementing a Component in Java

•	Using an MTS Component from Java

•	Using the Java Sample Bank Components

Implementing a Component in Java

To implement a component in Java, follow these steps

1	Run the ActiveX Component Wizard for Java (available with Visual J++) for each Java class file. Use the wizard to create new IDL files.

2	Modify the IDL files to add JAVACLASS and PROGID to the coclass attributes. See "Using IDL Files with Java Components."

3	Run the ActiveX Component Wizard for Java again. Use the IDL files that you created in Step 1 to create type libraries for your components.

This will create a set of Java class files, typically under \%systemroot%\Java\Trustlib. It will create one class file for each custom interface, and one class file for each coclass in the library.

4	Run JAVAGUID against each class file generated in Step 3. See "Working with GUIDs in Java" for more information.

5	Recompile your Java implementation classes.

6	Run EXEGEN to convert the type libraries and class files into a DLL. See "Using EXEGEN to Create DLLs."

7	Use the MTS Explorer to install the DLL.

Using IDL Files with Java Components

To specify the custom attributes in a type library, add the following in your IDL or ODL file:

#include <JavaAttr.h>

Within the attributes section of a coclass, specify the JAVACLASS:

JAVACLASS("package.class")

You may optionally specify a PROGID:

PROGID("Progid")

For example:

[

uuid(a2cda060-2d38-11d0-b94b-0080c7394688),

helpstring("Account Class"),

JAVACLASS("Account.AccountObj"),

PROGID("Bank.Account.VJ"),

TRANSACTION_REQUIRED

]

coclass CAccount

{

[default] interface IAccount;

};

Using EXEGEN to Create DLLs

EXEGEN is the Java executable file generator. To use this file, copy it to the appropriate destination folders (usually \JavaSDK\bin). This version of EXEGEN.EXE is capable of creating DLL files from Java classes, and can also include user-specified resources in its output files. This version of EXEGEN no longer supports the /base: directive. Class files are always included with the proper name. It supports a new /D directive that causes it to generate a DLL file instead of an EXE.

EXEGEN is now capable of reading five types of input files:

•	Java class files

•	RES files containg resources to be included

•	Executable files containg resources to be included

•	TLB files containing type libraries to be included

•	Text files describing which classes should be registered (DLL only).

If you use EXEGEN to create a DLL, the DLL can self-register any included Java classes that implement COM objects. There are two ways to tell EXEGEN which classes should be registered:

•	Include a type library that contains custom attributes for the classes. This is the preferred method.

– or –

•	Include a text file as input that gives EXEGEN the necessary directions. Each line of the text file describes one Java class, using the following keywords:

•	class:JavaClassName

Required keyword.

•	clsid:{.....}

Optional keyword that specifies the clsid GUID. If omitted, EXEGEN chooses a unique GUID.

•	progid:ProgId

Optional keyword. If omitted, the class will be registered without a progid.

Working with GUIDs in Java

When an MTS method uses a GUID parameter, you must pass an instance of class com.ms.com._Guid. Do not use class Guid, CLSID or IID from package com.ms.com; they will not work and they are deprecated. The definition of class _Guid is:

package com.ms.com;

public final class _Guid {

// Constructors

public _Guid (String s);

public _Guid (byte[] b);

public _Guid (int a, short b, short c,

byte b0, byte b1, byte b2, byte b3,

byte b4, byte b5, byte b6, byte b7);

public _Guid ();

// methods

public void set(byte[] b);

public void set(String s);

public void set(int a, short b, short c,

byte b0, byte b1, byte b2, byte b3,

byte b4, byte b5, byte b6, byte b7);

public byte[] toByteArray();

public String toString();

}

Instances of this class can be constructed from a String (in the form «{00000000-0000-0000-0000-000000000000}»), from an array of 16 bytes, or from the usual parts of a Guid. Once constructed, the value can also be changed. Method toByteArray will return an array of 16 bytes as stored in the Guid, and method toString will return a string in the same form used by the constructor.

JAVAGUID.EXE

Microsoft Transaction Server supplies a tool, JAVAGUID.EXE, that will post-process the output of JAVATLB. The following occurs for each class file:

•	If any method takes a GUID as a parameter, the class of that parameter will be changed to com.ms.com._Guid.

•	If the class file is an interface derived from a type library, a public static final member named iid will be added to the class. This member will contain the interface ID of the interface.

•	If the class file represents a coclass derived from a type library, a public static final member named clsid will be added to the class. This member will contain the CLSID of the class.

The clsid and iid members that JAVAGUID adds are useful as parameters to IObjectContext.CreateInstance and ITransactionContextEx.CreateInstance.

JAVAGUID can only be executed from the command line. It takes one or more parameters which are names of class files to update.

JAVATLB will eventually be updated to make JAVAGUID unnecessary.

Using an MTS Component from Java

To use an MTS component from Java, run the Java Type Library Wizard against the type library for the component. This will create several Java class files, typically under \%systemroot%\Java\TrustLib. It will create one class file for each custom interface, and one class file for each coclass in the library.

Assume, for example, that the type library contained one interface named IMyInterface, and one coclass, named CMyClass.

From Java, you can create a new instance of the component by executing

new CMyClass()

If you want to control transaction boundaries in the class, you can execute

ITransactionContextEx.CreateInstance ( CMyClass.clsid, IMyInterface.iid )

You should never call Java’s new operator on the class that you implemented. Instead, use one of the following techniques:

•	Use Java's new operator on the class created by the Java Type Library Wizard. This will cause the Java VM to call CoCreateInstance.

•	Call MTx.GetObjectContext().CreateInstance (clsid, iid);
This will create a new instance in the same activity as the current instance. This only works if the calling code is itself an MTS component.

•	If you have a reference to an ITransactionContextEx object, call its CreateInstance method. This will create a new instance in the transaction owned by the ITransactionContextEx object.

All of these techinques will result in the creation of a new instance of the class that you implemented.

Using the Java Sample Bank Components

The Java Sample Bank components are automatically configured by MTS Setup and require no additional steps in order to run them.

If you want to recompile the Java Sample Bank components, follow these steps:

1	Run the SetJavaDev.bat file located in the \mts\Samples\Account.VJ folder. Javatlb.exe must be in your path for this batch file to run properly.

2	Recompile your Java component implementation classes.

3	After you recompile the component classes, use the mkdll.bat file located in the \mts\Samples\Account.VJ folder to generate and register vjacct.dll. Exegen.exe must be in your path for this batch file to run properly. You can also add running mkdll.bat as a build step to your Visual J++ project to simplify recompiling.

4	Using the MTS Explorer, import the new components into the Sample Bank package.


Debugging MTS Components

This document describes techniques for debugging MTS components written in Microsoft® Visual Basic®, Microsoft Visual C++®, and Microsoft Visual J++™. These techniques are just suggestions for successfully debugging MTS components; you can choose your debugging environment and techniques according to your application needs.

If you are using MTS components in a distributed environment, it is recommended that you debug your components on a single computer before deploying to multiple servers. Components that function without error in a package on a local computer usually run successfully over a distributed network. If you do encounter problems with distributed components, you must test and debug both the client and server machines to determine the problem. It is also recommended that you stress test your application with as many clients as possible. You can build a test client that simulates multiple clients to perform the stress test on your application.

For debugging MTS components written in a specific language, see the following topics:

Debugging Visual Basic MTS Components

Debugging Visual C++ MTS Components

Debugging Java Classes


Debugging Visual Basic MTS Components

Microsoft Transaction Server components written in Visual Basic version 5.0 or Visual C++ version 5.0 can be debugged in the Microsoft Visual Studio 97 Integrated Development Environment (IDE).

If you want to debug your components after they are compiled, you cannot use the Visual Basic 5.0 debugger, which only debugs at design time. To debug a compiled Visual Basic component, you will need to use the functionality of the Visual Studio 97 debugger.

Follow these steps to configure Visual Studio to debug MTS components built with Visual Basic 5.0:

1	In Visual Basic, click Properties on the Project menu and then click the Compile tab to select the Compile to Native Code and the Create Symbolic Debug Info checkbox. It is also recommended that you select the No Optimization checkbox while debugging.

2	In the MTS Explorer, right-click the package in which your component is installed, and select the Properties option. Place your cursor over the Package ID, and select and copy the GUID to the clipboard.

3	Open Visual Studio. On the File menu, click Open and select the DLL containing the component that you want to debug.

4	Select Project Settings, and then click the Debug tab. Select the MTS executable for the debug session (\mtx\mtx.exe). Enter the program arguments as /p:{<package GUID>} for the package GUID that you copied from the package properties. MTS 2.0 allows for the package name to be used in place of the GUID. Open the .cls files containing the code that you want to debug and then set your breakpoints. If you also want to display variable information in the debug environment, go to the Visual Studio Tools menu, select Options, and then select the Debug tab. In the Debug tab, place a check next to Display Unicode strings.

5	In the MTS Explorer, shut down all server processes.

6	In Visual Studio, select Build, then select Start Debug. Then select Go to run the server process that will host your component(s), and set breakpoints to step through your code.

7	Run your client application to access and debug your components in Visual Studio.

8	Before you deploy your application, remember to select one of the optimizing options in the Compile tab on the Project menu of Visual Basic (set to No Optimization in Step 1), clear the Create Symbolic Debug Info checkbox, and recompile the project.

To facilitate application debugging using Visual Basic 5.0, a component that uses ObjectContext can be debugged by enabling a special version of the object context. This debug-only version is enabled by creating the registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Transaction Server\Debug\RunWithoutContext

Note that when running in debug mode, none of the functionality of MTS is enabled. GetObjectContext will return the debug ObjectContext rather than returning Nothing.

When running in this debug mode, the ObjectContext operates as follows:

•	ObjectContext.CreateInstance - calls COM CoCreateInstance (no context flows, no transactions, and so on)

•	ObjectContext.SetComplete - no effect

•	ObjectContext.SetAbort - no effect

•	ObjectContext.EnableCommit - no effect

•	ObjectContext.DisableCommit - no effect

•	ObjectContext.IsInTransaction - returns FALSE

•	ObjectContext.IsSecurityEnabled - returns FALSE

•	ObjectContext.IsCallerInRole - returns TRUE (same as normal when IsSecurityEnabled is FALSE)

You can also develop your own testing message box functions to generate an assert in an MTS Visual Basic component. The following sample code can to used to display error messages while debugging Visual Basic code. You can also use this in conjunction with the Microsoft Windows NT® debugger (WinDbg.exe), which is a 32-bit application that, along with a collection of DLLs, is used for debugging the Kernel, device drivers, and applications. Note that you must enter DEBUGGING = -1 in the Conditional Compilation dialog box (located on the Make tab of the Project Properties dialog box) to enable the assert.

The following code provides an example.

#If DEBUGGING Then

    'API Functions

    Private Declare Sub OutputDebugStringA _

        Lib "KERNEL32" (ByVal strError As String)

    Private Declare Function MessageBoxA _

        Lib "USER32" (ByVal hwnd As Long, _

        ByVal lpText As String, _

        ByVal lpCaption As String, _

        ByVal uType As Long) As Long

    'API Constants

    Private Const API_NULL                  As Long = 0

    Private Const MB_ICONERROR              As Long = &H10

    Private Const MB_SERVICE_NOTIFICATION As Long = &H200000

Public Sub DebugPrint(ByVal strError As String)

    Call OutputDebugStringA(strError)

End Sub

Public Sub DebugMessage(ByVal strError As String)

Dim lngReturn As Long

        lngReturn = MessageBoxA(API_NULL, strError, "Error In Component", _

            MB_ICONERROR Or MB_SERVICE_NOTIFICATION)

End Sub

#End If

You can then run checks through your code to aid stress debugging, such as in the following code:

SetobjObjectContext=GetObjectContext()

#If DEBUGGING Then

If objObjectContext Is Nothing Then Call DebugMessage("Context is Not Available")

#End If


Debugging Visual C++ MTS Components

You can use Visual Studio 97 to debug MTS components written in Visual C++, including components that call SQL Server functions or stored procedures. For more information, see Debugging Visual Basic MTS Components.

The following information applies to components that have their activation property set to In a dedicated server process.

Microsoft Transaction Server supports the COM transparent remote debugging infrastructure. If transparent remote debugging is enabled, then stepping into a client process will automatically stop at the actual object's code in the server process, even if the server is on a different computer on the network. A debugging session is automatically started on the server process if necessary. Similarly, single stepping past the return address of code in a server object will automatically stop just past the corresponding call site in the client's process.

In Microsoft Visual C++, selecting the OLE RPC debugging check box (on the Tools menu, select the Options submenu and choose the Debug property sheet) enables transparent remote debugging. It is not known at this time whether other debuggers support this infrastructure.

You can also debug your Microsoft Transaction Server component DLL in Visual C++ by performing the following steps. Each of these steps is made either inside the MTS Explorer or inside of a Visual C++ session with your MTS DLL project.

1	Shutdown server processes using the MTS Explorer. To do this, right-click My Computer, and select Shutdown Server Process.

3	In your Visual C++ session, under Project, Settings, Debug, General, set the program arguments to the following string: "/p: PackageName", for example:

/p: "Sample Bank"

4	In the same property sheet, set the executable to the full path of the Mtx.exe process, for example: "c:\MTx\MTx.exe".

5	Set breakpoints in your component DLL, and you are ready to debug.

6	Run the server process (in the Build menu, select Start Debug and click Go.)

The following information applies to in-process component DLLs that have their activation property set to In the creator's process.

You can debug your in-process MTS component DLL in Visual C++ by performing the following steps. Each of these steps is made inside a Visual C++ session with your base process project.

1	Set the component DLL under Build, Settings, Debug, Additional DLLs.

2	Now you are ready to step into or set breakpoints in your component DLL at will.

If you are using Visual Studio and Microsoft Foundation Classes (MFC) to debug, the TRACE macro can facilitate your debugging. The TRACE macro is an output debug function that traces debugging output to evaluate argument validity. The TRACE macro expressions specify a variable number of arguments that are used in exactly the same way that a variable number of arguments are used in the run-time function printf. The TRACE macro provides similar functionality to the printf function by sending a formatted string to a dump device such as a file or debug monitor. Like printf for C programs under MS-DOS, the TRACE macro is a convenient way to track the value of variables as your program executes. In the Debug environment, the TRACE macro output goes to afxDump. In the Release environment, the TRACE macro output does nothing.

Example:

// example for TRACE

int i = 1;

char sz[] = "one";

TRACE( "Integer = %d, String = %s\n", i, sz );

// Output: 'Integer = 1, String = one'

The TRACE macro is available only in the debug version of MFC, but a similar function could be written for use without MFC. For more information on using the TRACE macro, see the "MFC Debugging Support" section in Microsoft Visual C++ Programmer's Guide.

Note that you should avoid using standard ASSERT code in Visual C++. Instead, it is recommended that you write assert macros like a MessageBox using the MB_SERVICE_NOTIFICATION flag, and TRACE macro statements using the OutputDebugString function call.


Debugging Java Classes

Debug your Java classes as thoroughly as possible before converting the Java classes into MTS components. Note that once your Java class is converted into an MTS component, it is not possible to step through the code in the Visual J++ debugger, or in any current debugging tool as well.

Sidebar: Using Visual J++ to Debug Java Classes

Microsoft Visual J++ (VJ++) provides a Java debugger that you can use to set breakpoints in your code. Note that when you are using VJ++ to debug, if you set a breakpoint in a Java source file before starting the debugging session, Visual J++ may not stop on the breakpoint. For performance reasons, the debugger preloads only the main class of your project. The main class is either the class with the same name as the project or the class you specify in VJ++. If you use the editor to set breakpoints in other classes before the classes are loaded, the breakpoints are disabled.

You can choose one of the following options to load the correct class so that the debugger stops at breakpoints.

•	Select the class in the category Additional Classes, located on the Debug tab of the Project Settings dialog box, and make sure the first column is checked. This loads the class when the debugging session starts.

•	Right-click a method in the ClassView pane of the Project Workspace and select Set Breakpoint from the Shortcut menu. This causes a break when program execution enters the method.

•	Set the breakpoint after Visual J++ has loaded the class during debugging. You may need to step through your Java source until the class is loaded.

When a method has one or more overloaded versions and shows up as a called method in the Call Stack window, the type and value for the parameters are not displayed in some cases. It appears as though the method takes no parameters. This occurs when the called method is not defined as the first version of the overloaded method in the class definition. For example, see the following class definition:

public class Test

   {

       int method(short s)

       {

           return s;

       }

       int method(int i)

       {

           return i;

       }

   }

If you were looking at a call to the second version of the method in the Call Stack window, it would appear without the type and value for the method:

method()

To view the method’s parameters, change the order of the method overloads so that the method that you are currently debugging is first in the class definition.

printf-style Debugging

You can use printf-style debugging to debug your Java classes without using a debugger. printf-style debugging involves including status text messages into your code, allowing you to "step through" your code without a debugger. You can also use printf-style debugging to return error information. The following code shows how you can add a System.out.println call to the try clause of the Hellojtx.HelloObj.SayHello sample.

try

{

System.out.println("This message is from the HelloObj implementation");

result[0] = "Hello from simple MTS Java sample";

MTx.GetObjectContext().SetComplete();

return 0;

}

The client must be a Java client class, and you must use the JVIEW console window to run that class. Note that you need to configure your component to run in the process of its caller, which is in this case JVIEW. Otherwise, this debugging technique results in your component running in the MTS server process (mtx.exe), which would put the println output in the bit bucket rather than the JVIEW console window.

Use the MTS Explorer to configure your component to run in the caller's process by following these steps.

1	Right-click the component.

2	Click the Properties option.

3	Click the Activation tab and clear the In a server process on this computer checkbox.

4	Select the In the creator’s process... checkbox.

5	Reload the Client class. Your component's println calls will be visible in the JVIEW console window.

Using the AWT Classes

You can also use the AWT (Abstract Window Toolkit) classes to display intermediate results, even if your component is running in a server process. The java.awt package provides an integrated set of classes to manage user interface components such as windows, dialog boxes, buttons, checkboxes, lists, menus, scrollbars, and text fields.

The following example demonstrates how to use the AWT classes to display intermediate results in a dialog box:

import java.awt.*;

public final class MyMessage extends Frame

{

private Button closeButton;

private Label textLabel;

// constructor

public MyMessage(String msg)

{

super("Debug Window");

Panel panel;

textLabel = new Label (msg, Label.CENTER);

closeButton = new Button ("Close");

setLayout (new BorderLayout (15, 15));

add ("Center", textLabel);

add ("South", closeButton);

pack();

show();

}

public boolean action (Event e, Object arg)

{

if (e.target == closeButton)

{

hide();

dispose();

return true;

}

return false;

}

}

Asynchronous Java Garbage Collection

Note that garbage collection for Java components is asynchronous to program execution and can cause unexpected behavior. This behavior especially affects MTS components that perform functions such as enumerating through the collections in the catalog because the collection count will be too high (garbage collection is not synchronized). To force synchronous release of references to COM or MTS objects, you can use the release method defined in class com.ms.com.ComLib.

Example:

Import com.ms.com.ComLib

…

ComLib.release(someMTSObject);

This method releases the reference to the object when the call is executed. Release the object reference when you are sure that the reference is no longer needed. Note that if you fail to release the reference, an application error is not returned. However, an incorrect collection count results because the object reference is released asynchronously when the garbage collector eventually runs.

You can also force the release of your reference and not call that released reference again.

Example:

myHello = null;

System.gc();

Note that forcing the release of an object reference consumes extensive system resources. It is recommended that you use the release method defined in com.ms.com.ComLib class to release references to MTS objects in a synchronous fashion.


Automating MTS Deployment

This document describes how you can use the scriptable administration objects to automate deployment and distribution of your MTS packages. The MTS Explorer lets you configure and deploy packages by using a graphical user interface rather than by programming code. However, you can use the scriptable administrative objects to automate administration tasks, such as program configuration and deployment. Note that the scriptable administrative objects support the same collection hierarchy as the MTS Explorer. The following figure shows the MTS Explorer collection hierarchy.

For more information about MTS Explorer functionality, see the Administrator's Guide.

Using the Scriptable Administration Objects

Microsoft Transaction Server contains Automation objects that you can use to program administrative and deployment procedures, including:

•	Installing a Pre-Built Package

•	Creating a New Package and Installing Components

•	Enumerating Through Installed Packages to Update Properties

•	Enumerating Through Installed Packages to Delete a Package

•	Enumerating Through Installed Components to Delete a Component

•	Accessing Related Collection Names

•	Accessing Property Information

•	Configuring a Role

•	Exporting a Package

•	Configuring a Client to Use Remote Components

Note that you can use the scriptable administration objects to automate any task in the MTS Explorer.

The scriptable administration objects are derived from the IDispatch interface, so you can use any Automation language to develop your package, such as Microsoft® Visual Basic® version 5.0, Microsoft Visual C++® version 5.0, Microsoft Visual Basic® Scripting Edition (VBScript), and Microsoft JScript™.

Each folder in the MTS Explorer hierarchy corresponds to a collection stored in the catalog data store. The following scriptable objects are used for administration:

•	Catalog

•	CatalogObject

•	CatalogCollection

•	PackageUtil

•	ComponentUtil

•	RemoteComponentUtil

The Catalog, CatalogObject, and CatalogCollection scriptable objects provide top-level functionality such as creating and modifying objects. The Catalog object enables you to connect to specific servers and access collections. Call the CatalogCollection object to enumerate, create, delete, and modify objects, as well as to access related collections. CatalogObject allows you to retrieve and set properties on an object. The Package, Component, Remote Component, and Role objects enable more specific task automation, such as installing components and exporting packages. This utility layer allows you to program very specific tasks for collection types, such as associating a role with a user or class of users.

The following diagram illustrates how the MTS scriptable administration objects interact with the MTS Explorer catalog:

Interface	Description
ICatalog	The Catalog object enables you to connect to specific servers and access collections.
ICatalogCollection	The CatalogCollection object can be used to enumerate objects, create, delete, and modify objects, and access related collections.
ICatalogObject	The CatalogObject object provides methods to get and set properties on an object.
IPackageUtil	The IPackageUtil object enables a package to be installed and exported within the Packages collection.
IComponentUtil	The IComponentUtil object provides methods to install a component in a specific collection and to import components registered as an in-process server.
IRemoteComponentUtil	You can use the IRemoteComponentUtil object to program your application to pull remote components from a package on a remote server.
IRoleAssociationUtil	Call methods on the IRoleAssociationUtil object to associate roles with a component or component interface.
For example, you can automate creating a new package and installing components into the new package by using the scriptable objects in the utility layer (Package, Component, Remote Component, and Role objects).

The following Visual Basic sample shows how to use the scriptable administration objects to create and install components into a new package named "My Package."

1	Declare the objects that you will be using to create and install components into a new package.

Dim catalog As Object

Dim packages As Object

Dim newPack As Object

Dim componentsInNewPack As Object

Dim util As Object

2	Use the On Error statement to handle run-time errors if a method returns a failure HRESULT. You can test and respond to MTS trappable errors using the On Error statement and the Err object.

On Error GoTo failed

3	Call the CreateObject method to create an instance of the Catalog object. Retrieve the top level Packages collection from the CatalogCollection object by calling the GetCollection method. Then call the Add method to add a new package.

Set catalog = CreateObject("MTSAdmin.Catalog.1")
Set packages = catalog.GetCollection("Packages")

Set newPack = packages.Add

Dim newPackID As String

4	Set the package name to "My Package" and save changes to the Packages collection.

newPackID = newPack.Key

newPack.Value("Name") = "My Package"

packages.savechanges

5	Call the GetCollection method to access the ComponentsInPackage collection. Then instantiate the ComponentUtil object in order to call the InstallComponent method to populate the new package with components.

Set componentsInNewPack =
    packages.GetCollection("ComponentsInPackage",
    newPackID)

Set util = componentsInNewPack.GetUtilInterface

util.InstallComponent"d:\dllfilepath", "", ""

Exit Sub

6	Use the Err object to display an error message if the installation of the package fails.

failed:

    MsgBox "Failure code " + Str$(Err.Number)

End Sub

For a complete description of how to program these procedures and more sample code, refer to the Administrator’s Guide.


MTS Error Diagnosis

This topic describes how to determine the source of an error in your MTS application. You can diagnose the source and obtain a description of application errors by using a combination of Microsoft® Windows NT®, MTS, and other tools. If you discover that the application error is caused by MTS, you can interpret the error message using the Win32 (Win32.h) or MTS header files (mts.h), or the Microsoft Visual C++® error utility.

For more information on debugging an MTS application, see Debugging MTS Components.

Finding the Source of the Error

If your server application is failing or causing unexpected behavior, you must first determine where your error occurred. Windows NT provides a system Event Viewer that tracks application, security, and system events. Refer to the Application Log in the Event Viewer first to check the application associated with the event message. (Because you can also archive event logs, you can track an event history of the error.) Selecting an entry in your log activates an Event Detail, which provides further information about the system event. If you attempt to run the Sample Bank client without starting the Microsoft Distributed Transaction Coordinator (MS DTC), you will be returned the following Automation error.

Since this error does not indicate which application caused the failure, you can reference the Application Log in the Event viewer, which shows the error was caused by MTS.

Note   If you are using MTS for Windows 95, events are written to text files in the \Windows\MTSLogs directory.

Interpreting Error Messages

The Event Viewer helps you determine the application source of the problem. You can use other tools to interpret individual error messages. Success, warning, and error values are returned using a 32-bit number known as a result handle, or HRESULT. HRESULTs are 32-bit values with several fields encoded in the value. A zero result indicates failure if that bit is set. A non-zero result can be a warning or informational message.

HRESULTs work differently, depending on the platform you are using. On 16-bit platforms, an HRESULT is generated from a 32-bit value known as a status code, or SCODE. On 32-bit platforms, an HRESULT is the same as an SCODE. Note that if you are returning HRESULTs from Java, you should throw an instance of com.ms.com.ComFailException to indicate failure. You can specify a particular HRESULT when constructing the ComFailException object. The HRESULT is used as the return value for the COM method. To indicate successful completion, you do not need to do anything; just return normally. To return S_FALSE, indicating a successful completion but a return value of Boolean False, throw an instance of com.ms.com.ComSuccessException. In Visual Basic, you use the Err.Raise function to set and the On Error… / Err.Number to retrieve HRESULTs.

For a list of the values of common system-defined HRESULTs, see ComFailException. For a complete list of system-defined HRESULT values, see the header file Winerror.h included with the Platform SDK.

MTS never changes the value of an HRESULT error code, such as E_UNEXPECTED or E_FAIL, returned by an MTS object method. When an MTS object returns an HRESULT status code (such as S_OK or S_FALSE), MTS may convert the status code into an MTS error code before it returns to the caller. This occurs, for example, when the application returns S_OK after calling the SetComplete function; if the object is the root of an automatic transaction that fails to commit, the HRESULT is converted to CONTEXT_E_ABORTED. When MTS converts a status code to an error code, all the method's output parameters are cleared. Returned references are released and the values of the returned object pointers are set to NULL.

The Mtx.h header file contains the MTS specific error codes. Winerror.h contains the error code definitions for the Win32 API. For an overview of error codes, see "Error Handling" in the COM portion of the Microsoft Platform SDK

You can also use the ERRLOOK utility in Microsoft Visual Studio™ 97 to retrieve a system error message or module error message based on the value entered. ERRLOOK retrieves the error message text automatically if you drag-and-drop a hexadecimal or decimal value from the Visual Studio debugger or other Automation-enabled application. You can also enter a value either by typing it in or pasting it from the IDE clipboard and clicking the Look Up option.

Contacting MTS Support

If you run into a problem that you cannot solve, you can contact Microsoft support with the following information:

•	Topography of the application where the error occurred, such as a description of packages, components, and interfaces

•	Application event log on all computers

•	Reproduction of the error, if possible

Troubleshooting

If you are having trouble diagnosing your problem, refer to the list of troubleshooting tips below:

•	Make sure that the Distributed Transaction Coordinator (DTC) is running on all servers.

•	Check network communication by first testing on a local computer to verify that the application works. If you are running TCP/IP on your network, you can then use the Windows NT Ping.exe utility to verify that the machines are on the network.

•	Make sure that SQL and DTC are either located on the same computer or that the DTC Client Configuration program specifies that the DTC is on another computer. If not, SQLConnect will return an error internally when called from a transactional component.

•	Set the MTS transaction timeout to a higher number than the default 60 seconds, otherwise MTS aborts the transaction after this time has lapsed. All subsequent calls to the component return immediately with CONTEXT_E_ABORTED.

•	Make sure that your ODBC drivers are thread-safe and do not have thread affinity.

•	If you have difficulty getting an application to work over several servers, reboot the client and then verify that your Windows NT domain controller is configured properly.

•	Turning off resource pooling may reveal that a resource dispenser used by your application is the source of the problem. You can turn off resource pooling by setting the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Transaction Server\Local Computer\My Computer:Resource Pooling=N

See the DCOM documentation and DCOM-related Knowledge Base articles if you are experiencing application errors that you suspect are caused by DCOM.


Creating a Simple ActiveX Component

This section gets you started quickly with a simple ActiveX™ component (Account). You then install, run, and monitor Account with the Microsoft Transaction Server (MTS) Explorer and a sample client (Bank).

	Scenario: Creating and Using a Simple ActiveX Component First, create your component (Account) and run it in the MTS run-time environment by using the Bank client. Then, add a database connection to Account and run it again.
	Creating the Account Component Create a new ActiveX component, Account.
	Creating the Bank Package Use the MTS Explorer to create a new package for your component.
	Installing the Account Component in the Bank Package Use the MTS Explorer to install your component in a package.
	Running and Monitoring the Account Component Use the Bank client to run your component, and use the MTS Explorer to monitor it.
	Modifying the Account Component: Add a Database Connection Modify your component so that it connects to a database. The connection will be pooled by the ODBC resource dispenser. Then use the Bank client to re-run the modified component.
	Application Design Notes: Sharing Resources Learn how to efficiently share resources, such as database connections, through the MTS Resource Dispenser Manager and resource dispensers.
See Also

Programming Concepts, Transaction Server Components, Building Scalable Components


Scenario: Creating and Using a Simple ActiveX Component

This scenario has two implementation stages. The initial stage consists of building a simple component: the Account component. You can implement Account by creating a project (Account.vbp) with a class module (Account.cls). The Account class module exposes one method, Post, that passes back a string indicating that it was called successfully. The following illustration depicts the first stage of this scenario.

The second stage of this scenario adds a database connection to get the appropriate account information from a database and update it. This demonstrates using a resource dispenser — in this case, the ODBC resource dispenser, which enables efficient connection pooling. The following illustration depicts the second stage of this scenario.

The rest of this section provides step-by-step instructions for creating, installing, and running the Account component in this scenario. You can find the Microsoft Visual Basic projects for each of these steps in the Step1 through Step8 folders in the \Samples\Account.VB folder of your Microsoft Transaction Server installation.

See Also

Programming Concepts, Application Design Notes: Sharing Resources, Transaction Server Components, Building Scalable Components, Creating the Account Component, Run and Monitor the Account Component, Modifying the Account Component, Application Design Notes: Resource Usage, Creating a Simple ActiveX Component


Creating the Account Component

The first step toward building a simple application that you can use with Microsoft Transaction Server (MTS) is to create a simple ActiveX™ component DLL (VBAcct.dll); the Account component provides one method, Post.

The information presented here assumes a basic understanding of how to use Microsoft Visual Basic to create ActiveX components.

Note   You cannot install executable files (.exe) in MTS. If you have a component built as an executable file, you must rebuild it as a dynamic-link library (DLL).

To create the Account component

1	Start Microsoft® Visual Basic™ and open the \Mts\Samples\Account.VB\Step1\Account.vbp project.

Click here to see the code for the Account component

2	Build the component as a DLL and save it as \Mts\Samples\Account.VB\Step1\VBAcct.dll.

See Also

Programming Concepts, Transaction Server Components, Building Scalable Components, Transaction Server Component Requirements, Run and Monitor the Account Component, Application Design Notes: Sharing Resources, Modifying the Account Component, Application Design Notes: Resource Usage, Creating a Simple ActiveX Component


Creating the Bank Package

To run your component in the MTS run-time environment, you need to create a package. For this scenario, you will create a package with a single component.

A package is a collection of components that you can deploy and manage as a unit. By grouping components into packages, you define the security and process boundaries for components running on a computer. The criteria for deciding how to group components into packages require achieving the optimum balance between performance, fault isolation, and load balancing.

You will create a package called Bank that will contain the Account component.

To create the Bank package

1	On the Start menu, point to Programs, point to Microsoft Transaction Server, and then click Transaction Server Explorer.

2	Create a new package named Bank. In the Set Package Identity dialog box, select Interactive user.

How?

You can use the General, Security, Advanced, Identity, and Activation tabs to configure a package. For this scenario, you will use the default settings for the package you just created.

See Also

What Does Creating a Package Mean?, Package Properties , Programming Concepts, Installing the Account Component in the Bank Package, Creating a Simple ActiveX Component


Installing the Account Component

To run your components in the Microsoft Transaction Server run-time environment, you first need to install them in a package. This means you need to install the Account component in the Bank package.

To install the Account component

•	Install the Account component into the Bank package you created in Creating the Bank Package. Use the Account component that you built in \Mts\Samples\Step1\Account.VB\VBAcct.dll.

How?

You can use the General, Transaction, and Security tabs to configure a component. For this scenario, you will use the default settings for the component you just installed.

See Also

Adding A Component to a Package, Component Properties , Creating the Bank Package, Creating a Simple ActiveX Component


Running and Monitoring the Account Component

Now that you have created the Bank package and installed the Account component in the Microsoft Transaction Server Explorer, you can run the Account component with the Bank client and monitor the component status in the Explorer.

Running your component in MTS brings immediate benefits to your application, even if it doesn't implement any of the MTS APIs. Such benefits include:

•	Simplified management of your components though an easy-to-use graphical tool, the MTS Explorer.

•	Location transparency—the ability to run your components in-process, locally, or remotely.

•	Thread management and component tracking.

•	Database connection pooling through the Resource Dispenser Manager and the ODBC resource dispenser (automatically provided if you call the ODBC API).

To run and monitor your component

1	In the left pane of the MTS Explorer, click the Components folder where you installed the Bank.Account component.

2	On the View menu, click Status view to display usage information for the Bank.Account component.

3	On the Start menu, point to Programs, point to Microsoft Transaction Server, and then click Bank Client.

Arrange the windows so that you can see the Bank Client window and the MTS Explorer window simultaneously. The form will default to credit $1 to account number 1.

4	In the Bank client, click the Account component.

5	Click Submit.

You should see the response Hello from Account.

6	In the Bank client, change the iterations from 1 of 0 to 1 of 100 and click Submit.

In the right pane of the MTS Explorer, you should see the values under the Objects and Activated columns change to 1 and back to 0.

See Also

Status View, Creating the Bank Package, Installing the Account Component in the Bank Package, Microsoft Transaction Server APIs, Maintaining MTS Packages, Creating a Simple ActiveX Component


Modifying the Account Component to Use the ODBC Resource Dispenser

In this section, you enhance the Account component by adding a database connection. You revise the Post method to access a database using ActiveX Data Objects (ADO) to obtain the appropriate account information. This demonstrates using a resource dispenser — in this case, the ODBC resource dispenser, which enables connections to be pooled for efficiency. You will also add a new class module, CreateTable, to the Account project.

To modify the Account component

1	Open the \Mts\Samples\Account.VB\Step2\Account.vbp project.

Click here to see the modified Account component

2	Build the component as a DLL and save it as \Mts\Samples\Account.VB\Step2\VBAcct.dll.

By adding a new class module, you have added a new COM component to this DLL. Therefore, you will need to delete the Account component in the Microsoft Transaction Server Explorer and then install the Account and the MoveMoney components.

To reinstall your components

1	Remove the Account component.

How?

2	Add the new components.

How?

Use the DLL you created in \Mts\Samples\Account.VB\Step2\VBAcct.dll.

You can now run the new component by using the Bank client. You should see a response Credit, balance is $ 1. (VB).

See Also

Creating the Account Component, Application Design Notes: Resource Usage, Programming Concepts, Creating a Simple ActiveX Component


Application Design Notes: Sharing Resources

Each time the Account object's Post method is called, it obtains, uses, and then releases its database connection. A database connection is a valuable resource. The most efficient model for resource usage in scalable applications is to use them sparingly, acquire them only when you really need them, and return them as soon as possible.

Historically, acquiring resources has been an expensive operation in terms of system performance. Many programs have adopted a strategy of acquiring resources and holding onto them until program termination. While this strategy is effective for single-user systems, building scalable server applications requires sharing these resources.

Microsoft Transaction Server provides an architecture for resource sharing through its Resource Dispenser Manager and resource dispensers. The Resource Dispenser Manager works with specific resource dispensers to automatically pool and recycle resources. The ODBC version 3.0 Driver Manager is a Microsoft Transaction Server resource dispenser, also referred to as the ODBC resource dispenser.

Although the Account component hasn't implemented any of the MTS-specific APIs, when you run it, MTS uses the ODBC resource dispenser. This happens automatically when the Post method uses ActiveX Data Objects (ADO) to access the database, because ADO in turn uses ODBC. Whenever any component running in the MTS run-time environment uses ODBC directly or indirectly, the component automatically uses the ODBC resource dispenser.

When the Account object releases the database connection, the connection is returned to a pool. When the Post method is called again, it requests the same database connection. Instead of creating a new connection, the ODBC resource dispenser recycles the pooled connection, which saves time and server resources.

The topic Building Scalable Components, shows you how to use just-in-time activation to use server resources even more efficiently, resulting in more scalable applications and improved performance.

See Also

Application Design Notes: Resource Usage, Building Scalable Components, Modifying the Account Component, Creating the Account Component, Creating a Simple ActiveX Component


Building Scalable Components

In this section, you'll learn how you can use just-in-time activation to use server resources efficiently, resulting in more scalable applications and improved performance. You'll also see how a simple change to the Account component allows it to scale efficiently and support a large number of clients, without requiring you to make any changes to the client.

	Scenario: Adding Just-In-Time Activation to the Account Component Add code to your Account component to take advantage of just-in-time activation, which releases the component's resources when Account has completed its work.
	Adding Code to Call GetObjectContext, SetComplete, and SetAbort Add code to call GetObjectContext, SetComplete, and SetAbort.
	Application Design Notes: Just-In-Time Activation Learn how to reuse resources efficiently so you can build scalable applications.
See Also

Context Objects, Deactivating Objects, Creating a Simple ActiveX Component, GetObjectContext method, SetAbort method, SetComplete method


Scenario: Adding Just-In-Time Activation to the Account Component

In this scenario, the Bank client creates an Account object from the Account component and calls its Post method, just as in Creating a Simple ActiveX Component. This time, Account obtains a reference to its context object. When it successfully completes its work on behalf of the client, it uses its context object to call SetComplete. If Account encounters an error and is unable to complete its work successfully, it uses its context object to call SetAbort. When Account calls either SetComplete or SetAbort, it indicates that it's finished with its work and that it doesn't need to maintain any private state for its client. This allows the MTS run-time environment to reclaim and reuse the Account object's resources.

See Also

Context Objects, Deactivating Objects, Application Design Notes: Just-In-Time Activation, GetObjectContext method, SetAbort method


Adding Code to Call GetObjectContext, SetComplete, and SetAbort

Every Transaction Server object has a context object associated with it. The context object is automatically created at the same time the object itself is created. You can use an object's context to declare when the object's work is complete, as shown in the following illustration.

Calling either of these methods notifies the MTS run-time environment that it can safely deactivate the object, making its resources available for reuse.

To implement the scenario for this chapter, you will modify the Post method to use the Account object's context object. Then you will use SetComplete and SetAbort to enable just-in-time activation.

First, you call GetObjectContext to get a reference to the context object. When an object has completed its work successfully, it should call SetComplete:

GetObjectContext.SetComplete

SetComplete notifies the MTS run-time environment that the Account object should be deactivated as soon as it returns control to the Bank client.

If the object encountered an error, it should call SetAbort. SetAbort also notifies the MTS run-time environment that the Account object should be deactivated as soon as it returns control to the Bank client.

GetObjectContext.SetAbort

To obtain a reference to an object's context

1	Open the \Mts\Samples\Account.VB\Step3\Account.vbp project.

Click here to see the Post method

2	Build the component as a DLL and save it as \Mts\Samples\Account.VB\Step3\VBAcct.dll.

Before you can run your new component again in MTS, the registry needs to be updated with the new component information. To do this, refresh the MTS Explorer window.

If you install the Development version of Microsoft Transaction Server, you will get a Visual Basic – compatible add-in that automates this process for you (select the VB Addin box during Setup). The next time you run Visual Basic, the add-in is automatically installed in Visual Basic. The add-in automatically refreshes all of your MTS component DLLs whenever you recompile your project.

You can also turn this feature on and off on a per-project basis by using the toggle command on the Visual Basic Add-Ins menu. To turn it on, on the Visual Basic Add-Ins menu, point to MS Transaction Server, and click AutoRefresh after compile of active project. This puts a check mark next to the command, indicating that the feature is activated. If you want to refresh all of your MTS components at any given time, on the Visual Basic Add-Ins menu, point to MS Transaction Server, and then click Refresh all components now.

Now you'll run the Account component again from the Bank client, and monitor its execution in the MTS Explorer's Status window. Follow the same steps as in "Running and Monitoring the Account Component."

When the Bank client creates the Account object, the number 1 will appear under Objects and Activated. This indicates that one object is executing in the MTS run-time environment, and that it is currently activated. When the client calls the Post method, the number 1 appears, briefly, under In Call. This indicates that one object is currently executing a method call. When the Post method returns control to the client, the number under Objects is still 1, but the numbers under Activated and In Call return to 0. This is because after calling SetComplete, the object is deactivated as soon as it returns from the current method call.

Note   Because the Post method executes so quickly, you may not actually see this sequence appear.

See Also

Context Objects, Deactivating Objects, Creating a Simple ActiveX Component, GetObjectContext method, SetAbort method, SetComplete method


Application Design Notes: Just-In-Time Activation

When you design a traditional application, you have two options:

•	A client can create, use, and release an object. The next time it needs the object, it creates it again.

The advantage to this technique is that it conserves server resources. The disadvantage is that, as your application scales up, your performance slows down. If the object is on a remote computer, each time an object is created, there must be a network round-trip, which negatively affects performance.

•	A client can create an object and hold onto it until the client no longer needs it.

The advantage of this approach is that it's faster. The problem with it is that, in a large-scale application, it quickly becomes expensive in terms of server resources.

While either of these approaches might be fine for a small-scale application, as your application scales up, they're both inefficient. Just-in-time activation provides the best of both approaches, while avoiding the disadvantages of each.

In Creating a Simple ActiveX Component, the Bank client controlled the Account object's life cycle. Clients held onto server resources even when the clients were idle. As you added more clients, you saw a proportional increase in the number of allocated objects and database connections. A quick look at the Account component shows that each call to the Post method is independent of any previous calls. An Account object doesn't need to maintain any private state to correctly process new requests from its client. It also doesn't need to maintain its database connection between calls. The only problem is that, in this scenario, the MTS run-time environment can't reclaim the object's resources until the client explicitly releases the object. If you have to depend on your clients to manage your object's resources, you can't build a scalable component.

By adding just a few lines of code, you were able to implement just-in-time activation in the Account component. When an Account object calls SetComplete, it notifies the MTS run-time environment that it should be deactivated as soon as it returns control to the client. This allows the MTS run-time environment to release the object's resources, including any database connection it holds prior to the object's release. The Bank client continues to hold a reference to the deactivated Account object.

When a client calls a method on a deactivated object, the client's reference is automatically bound to a new object. Thus, the client has the illusion of a continuous reference to a single object, without tying up server resources unnecessarily.

Although the call to SetAbort has a similar effect, it isn't apparent in this scenario why it is used when errors occur. The next chapter, Building Transactional Components, shows you how transactions can make your applications more robust in the event of an error.

See Also

Context Objects, Deactivating Objects, Creating a Simple ActiveX Component, GetObjectContext method, SetAbort method, SetComplete method


Building Transactional Components

This section introduces transactional components and the benefits of running components within the same transaction.

	Scenario: Composing Work from Multiple Components Under the Same Transaction Add new functionality to transfer money between accounts by adding a new component, MoveMoney, which uses the existing Account component.
	Creating the MoveMoney Component Use the CreateInstance method to run the MoveMoney and Account components within the same transaction.
	Monitoring Transactions Use the Bank client to run your components, and use the Microsoft Transaction Server Explorer to monitor transactions.
	Application Design Notes: Using Context and Transactions Using transactional components provides atomicity and simplified error recovery.
See Also

Transactions, Transaction Attributes, ObjectContext object, CreateInstance method


Scenario: Composing Work from Multiple Components Under the Same Transaction

For this scenario, you will add new functionality that allows you to transfer money between two accounts. To implement this, you add a new component, MoveMoney. MoveMoney creates Account and then calls it once for a credit or debit, or twice for a transfer, as shown here.

Because either MoveMoney or Account could fail at any point, all database updates need to be in the same transaction to ensure that the database remains consistent. To do this, you configure the MoveMoney and Account components in the Microsoft Transaction Server Explorer to require a transaction. Transaction Server ensures that all their objects' work is automatically done in the same transaction.

See Also

Transactions, Transaction Attributes


Creating the MoveMoney Component

To implement this scenario, you will add a new class module, MoveMoney, to the Account project. MoveMoney has a single method, Perform, which creates an Account object to perform the credit, debit, or transfer.

To create the MoveMoney component

1	Open the \Mts\Samples\Account.VB\Step4\Account.vbp project.

Click here to see the Perform method

2	Build the component as a dynamic-link library (DLL) and save it as \Mts\Samples\Account.VB\Step4\VBAcct.dll.

By adding a new class module, you have added a new COM component to this DLL. Therefore, you will need to delete the Account component in the Microsoft Transaction Server Explorer and then install the Account and the MoveMoney components.

To reinstall your components

1	Remove the Account and CreateTable components.

How?

2	Add the new components.

How?

Use the DLL you created in the previous procedure. You can find it in \Mts\Samples\Account.VB\Step4\VBAcct.dll.

MTS enlists a component in a transaction as specified by the component's transaction attribute. For this scenario, Account and MoveMoney run within the same transaction.

To set the transaction attributes for your components

1	For the Account and MoveMoney components, set the transaction attribute to Requires a transaction.

2	For the CreateTable component, set the transaction attribute to Requires a new transaction.

How?

The MoveMoney object uses CreateInstance to create the Account object. CreateInstance is a method on the context object. By using CreateInstance, the Account object created by MoveMoney shares context with MoveMoney.

Dim objAccount As Bank.Account

Set objAccount = _

    GetObjectContext.CreateInstance("Bank.Account")

Transactions are associated with an object's context. Because both MoveMoney and Account have a transaction attribute of Requires a transaction, the Account object will be enlisted within the same transaction as MoveMoney.

In Building Scalable Components, you learned how to use SetComplete to indicate that an object has finished its work and can be deactivated. For transactional components, calling SetComplete indicates that a transaction can be committed.

GetObjectContext.SetComplete

When the Perform method returns, the transaction attempts to commit. There is no guarantee that it will commit, however. If an error occurs, Perform instead calls SetAbort.

GetObjectContext.SetAbort

SetAbort also indicates that an object has finished its work, but that it isn't in a consistent state. When the Perform method returns after calling SetAbort, the attempt to commit the transaction won't succeed.

See Also

Transactions, Transaction Attributes, Context Objects, Creating MTS Objects, ObjectContext object, CreateInstance method, GetObjectContext method, SetAbort method, SetComplete method


Monitoring Transaction Statistics

You can use the Microsoft Transaction Server Explorer to monitor commit and abort statistics for transactions.

You can experiment with the MoveMoney and Account components to see how transactions are committed and aborted as you provide user input with the Bank client.

To monitor transactions

1	On the Window menu of the Transaction Server Explorer, click New Window.

2	In the left pane, click Transaction Statistics.

3	On the Action menu, click Scope Pane to hide the left pane of the Explorer.

4	Make sure that the Microsoft Distributed Transaction Coordinator (MS DTC) is running on your SQL Server computer. You can start MS DTC from the Transaction Server Explorer or from SQL Server.

5	Also make sure that you have the ODBC data source set up, and that SQL Server is running. Click [image] to get information on how to do this.

6	Start the Bank client.

Rearrange the windows so that you see the two Microsoft Transaction Server Explorer windows and the Bank client window.

To monitor a commit, click Submit in the Bank client. The Transaction Statistics window first indicates that one transaction is active, and indicates that one transaction was committed.

To monitor an abort, click Debit in the Bank client, and enter an amount for the transaction that is greater than the balance on your account. Click Submit. The Transaction Statistics window first indicates that one transaction is active, and then indicates that one transaction was aborted.

Try experimenting with Transfer. Verify that both objects are running within the same transaction by checking the balance of two accounts and performing a transfer that would overdraw from an account. Notice that both the credit and the debit are aborted.

See Also

Monitoring Transactions in MTS


Application Design Notes: Using Context and Transactions

Context simplifies defining transactions. A transaction is automatically started when a component is declared as transactional. Components don't need to add additional code to indicate the start and end of a transaction. Using context allows you to define the scope of a transaction.

Besides simplifying building components, automatic transaction enlistment also allows for reuse of existing components. Changing the transaction attribute is the only change to the Account component from the previous section, Building Scalable Components.

Creating the Account object from MoveMoney establishes MoveMoney as the root of the transaction. The root transaction attempts to commit after it has completed its work. If an Account object calls SetAbort to indicate that it cannot successfully commit its work, then when the root transaction attempts to commit, the entire transaction will fail.

In the case of a money transfer, this provides atomicity. If a credit succeeds, but insufficient funds prevent the debit from succeeding, then the credit will be rolled back from the database automatically. Thus, SetAbort provides simplified error recovery.

Context simplifies the development of the component. Each object independently acquires its own resources, performs its work, and indicates its own internal state by using SetComplete or SetAbort before returning.

See Also

Transactions, Transaction Attributes, Context Objects, CreateInstance method, ObjectContext object, SetAbort method, SetComplete method


Sharing State

This chapter shows you how to use the Shared Property Manager to share state among multiple Microsoft Transaction Server objects running in the same process.

	Scenario: A Receipt Number Generator That Uses the Shared Property Manager Create a component that uses the Shared Property Manager to generate a unique receipt number for each bank transaction.
	Creating the Receipt Component Create a SharedProperty object to get a new receipt number, with appropriate isolation and release modes for this scenario.
	Application Design Notes: Sharing State by Using the Shared Property Manager Learn some of the advantages of using the Shared Property Manager to manage shared state within a process.
See Also

Resource Dispensers, Stateful Components, SharedPropertyGroupManager object


Scenario: A Receipt Number Generator That Uses the Shared Property Manager

This chapter introduces the Receipt component, which dispenses unique receipt numbers for fund transfers. When a bank transaction takes place, the MoveMoney object creates a Receipt object. The Receipt component contains a single method, GetNextReceipt.

GetNextReceipt uses the Shared Property Manager to get a unique receipt number. The Shared Property Manager has an object hierarchy as shown in the following figure:

Within a server process, there is only one instance of the SharedPropertyGroupManager object. The value of the receipt number is maintained by a SharedProperty object, which provides locking mechanisms to ensure that no two calls to GetNextReceipt retrieve the same value.

See Also

Resource Dispensers, Creating the Receipt Component, Application Design Notes: Sharing State by Using the Shared Property Manager, SharedPropertyGroupManager object, SharedPropertyGroup object, SharedProperty object


Creating the Receipt Component

The Receipt component contains a single method, GetNextReceipt. The Receipt object itself doesn't maintain the value of the receipt number between calls. The Shared Property Manager maintains these values. The Receipt object calls a SharedProperty object to get a new receipt number.

You will also add code to the MoveMoney component to call the Receipt component.

To create the Receipt Component

1	Start Microsoft Visual Basic and open the \Mts\Samples\Account.VB\Step5\Account.vbp project.

Click here to see the code for the Receipt component

Click here to see the code for the MoveMoney component

2	Build the component as a DLL and save it as \Mts\Samples\Account.VB\Step5\VBAcct.dll.

By adding a new class module, you add a new COM component to this DLL. Therefore, you need to delete the existing components in the Microsoft Transaction Server Explorer and then install the new components.

To reinstall your components

1	Remove the Account, MoveMoney, and CreateTable components from the Transaction Server Explorer.

How?

2	Add the new components. Use the DLL you created in \Mts\Samples\Account.VB\Step5\VBAcct.dll.

How?

To set the transaction attributes for your components

1	For the Account and MoveMoney components, set the transaction attribute to Requires a transaction.

How?

2	For the CreateTable component, set the transaction attribute to Requires a new transaction.

3	For the Receipt component, set the transaction attribute to Does not support transactions. This is the default value.

Note that the Receipt component is not transactional because the receipts are maintained as properties in memory and aren't durable.

When you run the Bank Client, select the MoveMoney button under Component. You should see the response Credit, balance is $ 1. (VB); Receipt No: #####.

The various object creation methods for Shared Property Manager objects are designed for simplified coding. If the object doesn't exist, it will be created. If it already exists, the object is returned. GetNextReceipt makes the following method call to access the shared property group manager:

Set spmMgr = CreateObject _

    ("MTxSpm.SharedPropertyGroupManager.1")

This code works every time it is called. There is no need to check if the shared property group manager has already been created. Such behavior also ensures that only one instance of the SharedPropertyGroupManager object exists per server process.

For the SharedPropertyGroup and SharedProperty objects, a flag is returned to indicate whether the property group or property already exists. The following code shows how this flag is used to determine if the property needs to be initialized:

Set spmPropNextReceipt = _

    spmGroup.CreateProperty("Next", bResult)

' Set the initial value of the SharedProperty to

' 0 if the SharedProperty didn't already exist.

If bResult = False Then

    spmPropNextReceipt.Value = 0

End If

Access to shared properties is controlled through the CreatePropertyGroup method:

Set spmGroup = _

    spmMgr.CreatePropertyGroup("Receipt", _

    LockMethod, Process, bResult)

CreatePropertyGroup has two parameters, isolation mode and release mode. The isolation mode for the Receipt property group is set to LockMethod, which ensures that two instances of the Receipt object can't read or write to the same property during a call to GetNextReceipt. The release mode for the Receipt property group is set to Process, which maintains the property group until the server process is terminated.

See Also

Application Design Notes: Sharing State by Using the Shared Property Manager, SharedPropertyGroupManager object, CreateProperty methodasmthCreatePropertyvb, CreatePropertyGroup methodasmthCreatePropertyGroupvb


Application Design Notes: Sharing State by Using the Shared Property Manager

Using the Shared Property Manager makes sharing state in a multiuser environment as easy as it is in a single-user environment. Without the use of the Shared Property Manager, the application would require much more code that has nothing to do with the business problem at hand.

One alternate way to create the same functionality would be to maintain the receipt number as a member variable of the Receipt component. However, this complicates coding the Receipt component immensely. The Receipt component would have to remain persistent in memory during the life of the server process. This would require the following additional code:

•	Referencing all instances of MoveMoney to the Receipt object.

•	Maintaining a locking mechanism to prevent concurrent access to the Receipt object.

Even after adding this code, the application wouldn't be extensible for additional shared properties. The Shared Property Manager is another example of how Microsoft Transaction Server provides the infrastructure for server applications so that you can concentrate on coding business logic.

Location Transparency and the Shared Property Manager

For objects to share state, they all must be running in the same server process with the Shared Property Manager.

To maintain location transparency, it's a good idea to limit the use of a shared property group to objects created by the same component, or to objects created by components implemented within the same DLL. When components provided by different DLLs use the same shared property group, you run the risk of an administrator moving one or more of those components into a different package. Because components in different packages generally run in different processes, objects created by those components would no longer be able to share properties.

See Also

Resource Dispensers, Stateful Components, SharedPropertyGroupManager object


Stateful Components

This section discusses stateful components and outlines some of the issues associated with writing stateful application components.

	Scenario: Holding State in the MoveMoney Component Consider the design alternative of holding state within objects.
	Adding a New Method to the MoveMoney Component Add the StatefulPerform method, which uses MoveMoney to maintain account number values.
	Application Design Notes: The Trade-offs of Using Stateful Objects Learn how holding state in objects affects the application behavior within the Microsoft Transaction Server run-time environment.
See Also

Transactions


Scenario: Holding State in the MoveMoney Component

Building stateful objects is a useful approach in application design. However, such design can have performance trade-offs. This section demonstrates how holding state in objects affects the application behavior within the Microsoft Transaction Server run-time environment.

You will modify the MoveMoney component to be stateful by adding the StatefulPerform function to MoveMoney. StatefulPerform is called when you click Stateful MoveMoney on the Sample Bank client. This new function causes MoveMoney to retain data in member variables between method calls.

See Also

Transactions, Deactivating Objects, Context Objects, Stateful Components


Adding a New Method to the MoveMoney Component

To implement the scenario for this section, you will add a method similar to Perform, named StatefulPerform, which uses class member variables to set account numbers. Thus, MoveMoney becomes a stateful object when StatefulPerform is called.

   To add a new function to the MoveMoney component

1	Open the \Mts\Samples\Account.VB\Step6\Account.vbp project.

Click here to see the StatefulPerform method

2	Build the component as a dynamic-link library (DLL) and save it as \Mts\Samples\Account.VB\Step6\VBAcct.dll.

The code for StatefulPerform calls the Perform method. The methods differ in how the account numbers are set. Class member variables for each account must be set before calling StatefulPerform, whereas Perform passes the account numbers by value through function parameters.

When you click the MoveMoney option in the Sample Bank client, it calls the following code to initialize the function:

StatefulPerform = Perform(PrimeAccount, SecondAccount, lngAmount, lngTranType)

When you click the Stateful MoveMoney option, the Sample Bank client calls the following code to initialize the function:

obj.PrimeAccount = PrimeAcct

obj.SecondAccount = lSecondAcct

Res = obj.StatefulPerform(CLng(Amount), TranType)

The PrimeAccount and SecondAccount properties are actually separate class member variables on the MoveMoney object. Note that the PrimeAccount and SecondAccount properties aren't accessed through the Shared Property Manager properties; the MoveMoney object controls getting and setting the account number values, thus making the MoveMoney object stateful.

Run the Bank client with the MoveMoney option. Then run it again with the Stateful MoveMoney option. You should notice that the stateless version is slightly faster. Try running multiple Bank clients with concurrent transactions. You should notice that the stateless version performs significantly better. The next section explains why.

See Also

Transactions, Deactivating Objects, Context Objects, Stateful Components


Application Design Notes: The Trade-offs of Using Stateful Objects

This section explains the trade-offs of using stateful objects in your applications.

Why does MoveMoney outperform Stateful MoveMoney?

In the previous section, you saw that the time per transaction in MoveMoney and Stateful MoveMoney using a single Sample Bank client is nearly the same. However, as the number of concurrent transactions increases, MoveMoney begins to outperform Stateful MoveMoney significantly . At first glance, the code doesn't seem to account for the lag.

Class member variables for each account must be set before calling StatefulPerform, whereas Perform passes the account numbers by value through function parameters. The call to return the value of the account number in the MoveMoney object isn't an intensive operation. So what explains the performance degradation?

The reason is that Microsoft Transaction Server cannot commit transactions until it completes a method call. To maintain internal state, additional method calls are made on the MoveMoney object, thereby delaying the object from completing its work. This delay may cause server resources, such as database connections, to be held longer, therefore decreasing the amount of resources available for other clients. In other words, the application won't scale well.

The following diagram illustrates this point. The arrow on the left indicates time, which translates into performance. The arrow on the right indicates the server resources consumed, which translates into throughput. Transaction A represents a call made to stateless objects. On return from the method call, Transaction Server determines that the transaction can be committed, allowing the object to release its resources and be deactivated. On the other hand, Transaction B holds state between method calls, which increases the time that the server holds onto resources for that transaction. As the number of clients increases, so does the time required for transactions to be completed.

Another Pitfall When Using Stateful Objects

Examine the following excerpt from the Sample Bank client code (some code has been omitted for clarity).

For i = 1 To nTrans

.

.

.

obj.PrimeAccount = PrimeAcct

obj.SecondAccount = lSecondAcct

Res = obj.StatefulPerform(CLng(Amount), TranType

.

.

.

Next i

Because the account numbers don't change, you might be inclined to rearrange the code as follows:

obj.PrimeAccount = PrimeAcct

obj.SecondAccount = lSecondAcct

For i = 1 To nTrans

Res = obj.StatefulPerform(CLng(Amount), TranType

Next i

If you modify the code and then run the Sample Bank client for multiple transactions, the application fails on the second transaction. Why?

The answer is subtle. MoveMoney uses SetComplete to notify Transaction Server that it has completed its work. At this point, the MoveMoney object is deactivated. In the process of deactivation, all of the object's member variables are reinitialized. The next call to MoveMoney causes just-in-time activation. The activated object is now in its initial state, meaning the values of PrimeAccountNo and SecondAccountNo are both zero. Thus, the next call to StatefulPerform fails because of an invalid account number.

This is yet another reason to be careful when maintaining state in objects. Clients of application objects must be aware of how an object uses SetComplete to ensure that any state the object maintains won't be needed after the object undergoes just-in-time activation.

See Also

Transactions, Deactivating Objects, Context Objects, Stateful Components, ObjectContext object, SetComplete method


Multiple Transactions

This section explains the benefits of distributing work among multiple transactions.

	Scenario: Storing Receipt Numbers in a Database Add the UpdateReceipt component, which stores a maximum receipt number in a database and runs in a new transaction.
	Creating the UpdateReceipt Component Create the UpdateReceipt component, and modify the Receipt component to use UpdateReceipt.
	Application Design Notes: Using Separate Transactions Learn why this scenario requires separate transactions.
See Also

Transactions, Transaction Attributes, Activities


Scenario: Storing Receipt Numbers in a Database

In Sharing State, you added the Receipt component, which assigns a unique receipt number to each monetary transaction. The Shared Property Manager maintains these values, so they exist for the duration of the server process. In this section, you will add code to store a maximum receipt number in a database. Storing them makes receipt numbers unique beyond the life of the server process.

You will create the UpdateReceipt component, which stores a maximum receipt number in a database. When this maximum is reached, which happens on every one-hundredth transaction, UpdateReceipt adds 100 to the maximum receipt value and updates the database.

You will install the UpdateReceipt component so that it creates a new transaction, separate from those of the Account objects. The section will then discuss the advantages of using multiple transactions in this scenario. The application looks like the following figure (the Shared Property Manager and its associated objects are omitted for clarity):

See Also

Transactions, Transaction Attributes, Activities, Sharing State


Creating the UpdateReceipt Component

To implement the scenario for this section, you will build the UpdateReceipt component. You will also modify the Receipt component's Update method to use UpdateReceipt. Update adds 100 to the maximum receipt value stored in the database.

Click here to see the Update method

You also need to add code to the GetNextReciept method of the Receipt component to check whether the maximum receipt value has been reached. If so, the Update method is called.

Click here to see the GetNextReceipt method

To create the UpdateReceipt component

1	Open the \Mts\Samples\Account.VB\Step7\Account.vbp project.

2	Build the component as a dynamic-link library (DLL) and save it as \Mts\Samples\Account.VB\Step7\VBAcct.dll.

By adding a new class module, you add a new COM component to this DLL. Therefore, you need to delete the existing components in the Microsoft Transaction Server Explorer and then install the new components.

To reinstall your components

1	Remove the Account, MoveMoney, CreateTable, and Receipt components from the Transaction Server Explorer.

How?

2	Add the new components. Use the DLL you created in \Mts\Samples\Account.VB\Step7\VBAcct.dll.

How?

To set the transaction attributes for your components

1	For the Account and MoveMoney components, set the transaction attribute to Requires a transaction.

How?

2	For the Receipt component, set the transaction attribute to Does not support transactions. This is the default value.

3	For the CreateTable and UpdateReceipt components, set the transaction attribute to Requires a new transaction.

The code you added here is similar to the code you added in "Building Transactional Components." However, choosing Requires a new transaction causes the UpdateReceipt component to run in a new transaction. The next section discusses how this affects application behavior.

See Also

Transactions, Transaction Attributes


Application Design Notes: Using Separate Transactions

In Building Transactional Components, you saw the benefits of composing work under a transaction. The scenario in this section demonstrates a case in which using multiple transactions within an activity is required.

The major functional change in this scenario is the addition of the UpdateReceipt component, which makes the maximum receipt number durable by storing it in a database. As in Sharing State, the Shared Property Manager stores the receipt number. On every 100 transactions, the value in the database is incremented by 100. This dispenses a block of receipt numbers that are assigned to the next 100 transactions.

The UpdateReceipt component has a transaction attribute of Requires a new transaction. This guarantees that UpdateReceipt's work happens in a separate transaction. Thus, there is no connection between the success or failure of Account's work and UpdateReceipt's work.

This might appear to lower the fault tolerance of the application. For example, if the Account object aborts the transaction, a receipt number is still assigned. Therefore, skips in the receipt number sequence are possible. However, the application doesn't really need consecutively increasing receipt numbers—it just requires that there be no duplicate receipts. In this scenario, it's more important for the monetary transaction to be completed properly. Furthermore, requesting an update on every one-hundredth transaction improves performance by conserving calls to the database.

Composing both database updates under a single transaction would reduce the application's scalability. Even though UpdateReceipt is a simple update, it would consume more server resources because the database connection would have to be maintained until the Account object has completed its work. Thus, locks would be held longer than necessary, preventing other clients from writing to the database. Only when all work has been completed could these resources be freed.

See Also

Transactions, Transaction Attributes


Secured Components

This chapter shows how to use Microsoft Transaction Server's security features to restrict the use of application features to designated users.

	Scenario: Adding Role Checking to the MoveMoney and Account Components Add role checking to the MoveMoney and Account components to limit the transaction amount for designated users.
	Using IsCallerInRole in the MoveMoney and Account Components Use the IsCallerInRole method in the MoveMoney and Account components to verify that the user running the Bank client is a manager.
	Application Design Notes: Using Roles Learn how roles are useful in building secured components and how security boundaries are determined.
See Also

Programmatic Security


Scenario: Adding Role Checking to the MoveMoney and Account Components

For this scenario, you will limit which users have the ability to perform transactions of more than $500. You will add code to the MoveMoney and Account components that checks to see if the user of the Bank client is a manager. This is accomplished by defining a Manager role. Roles provide the flexibility a developer needs to build secured components without tying the implementation to a specific deployment domain.

See Also

Programmatic Security, Application Design Notes: Using Roles


Using IsCallerInRole in the MoveMoney and Account Components

You will add the IsCallerInRole method to the MoveMoney and Account components to verify that the user running the Bank client is a manager. This additional code is the same for both components. You must modify both components because clicking Account in the Bank client doesn't use the MoveMoney component when the Sample Bank application runs.

To use IsCallerInRole in the MoveMoney and Account components

1	Open the \Mts\Samples\Account.VB\Step8\Account.vbp project.

Click here to see the modified MoveMoney component

Click here to see the modified Account component

2	Build the component as a DLL and save it as \Mts\Samples\Account.VB\Step8\VBAcct.dll.

IsCallerInRole is a method on an object's context. IsCallerInRole returns TRUE if the direct caller of that object is assigned to a given role. You will use IsCallerInRole in the MoveMoney and Account components to verify if the caller of an object — in this case the user running the Bank client — is a manager.

If (lngAmount > 500 Or lngAmount < -500) Then

    If Not GetObjectContext.IsCallerInRole("Managers") Then

        Err.Raise Number:=APP_ERROR, _

        Description:="Need 'Managers' role for amounts over $500"

    End If

End If

Before you can use the new MoveMoney and Account components, you must create the role. The Manager role must exist before the call to IsCallerInRole; otherwise, you will get an error.

Note that the source code is bound to a role name scoped to a package. This creates a dependancy between the source and the package definition that must be considered when making modifications to a Package's security configuration, such as deleting a role.

To define a role for the Sample Bank package

1	Start the Microsoft Transaction Server Explorer.

If you are currently running Sample Bank, you must shut down the associated server process to change security properties.

How?

2	Create a role named Manager.

How?

3	Assign users to the role. If you have access to more than one Windows NT account, you may want to exclude some user accounts from the Manager role to see the role checking in effect.

How?

Run the Bank client. If you are logged on as a user in the Manager role, you will be able to perform transactions of any amount. However, if you are logged on as a user who isn't in the Manager role, you will get a warning message when attempting a transaction of more than $500. The transaction will then abort. If you don't have access to more than one account, try removing your user account from the role to see the role checking enforced.

How?

See Also

Programmatic Security, Enabling MTS Package Security, Application Design Notes: Using Roles, IsCallerInRole method


Application Design Notes: Using Roles

This section explains how roles are useful in building secured components. It also discusses how deployment configuration determines security boundaries.

Roles

A role is a symbolic name that defines a group of users for a package of components. Roles extend Windows NT security to allow a developer to build secured components in a distributed application. In this scenario, the Manager role is defined at development time, but not yet bound to specific users. For each deployment of the application, the administrator can then assign the users and groups to a role in order to customize the application for his or her business.

In this scenario, role checking is done by the MoveMoney and Account objects. When both MoveMoney and Account objects are used, the second check (on the Account object) is redundant. However, it yields the same result, because IsCallerInRole applies to the direct caller, and both the MoveMoney and Account objects run in the same server process.

If you place the MoveMoney and Account components into separate packages, the components run in separate server processes. In this scenario, calling IsCallerInRole on the Account object context would check if the MoveMoney object's associated server process is running in the Manager role. MoveMoney is now the direct caller because a process boundary has been crossed.

The Account object runs under a package identity that gives that process full access to the bank account database. Account objects have the authority to update any account for any amount. Roles provide a means of permitting and denying access to objects. Once this permission is granted, the client, in effect, has the same access rights as the server process.

When you configured the package, you chose a package identity of Interactive User. In a real-world scenario, packages are more likely to run as a specific user, such as SampleBank, which has access rights to the database.

Returning to the scenario where you split the MoveMoney and Account components into separate packages, running as the SampleBank user solves the role checking problem. Adding the SampleBank user to the Manager role would allow the second IsCallerInRole check (on the Account object) to always succeed.

Security Boundaries Are Process-Wide

Transaction Server security is enabled only within a server process. Because the MoveMoney component is configured to run within a server process, role checking is enabled.

If you configure the Sample Bank components to run in-process, role checking would be disabled. In this case, IsCallerInRole always returns TRUE, which means the direct caller would always pass the authorization check.

You could use the IsSecurityEnabled method to check if Transaction Server security can be used. IsSecurityEnabled returns FALSE when the object runs in-process. Using IsSecurityEnabled, you could rewrite the role-checking code to disable transactions when objects aren't running in a secured environment.

In-process components share the same level of trust as the base client. Because of this, it isn't recommended that you deploy your secured components to be loaded in-process with their clients.

See Also

Programmatic Security, Enabling MTS Package Security, IsCallerInRole method, IsSecurityEnabled method


MTS Reference

Visual Basic

Functions

Methods

Objects

Properties

Language Summary

Visual C++

Functions

Interfaces

Methods

Language Summary

Visual J++

Interfaces

Methods

Language Summary


Functions (Visual Basic)

GetObjectContext

SafeRef


Objects (Visual Basic)

You use the following object in base clients:

TransactionContext

You use the following objects in components:

ObjectContext

SecurityProperty

SharedProperty

SharedPropertyGroup

SharedPropertyGroupManager


Methods (Visual Basic)

Abort

Activate

CanBePooled

Commit

Count

CreateInstance

CreateInstance (Transaction Context)

CreatePropertyGroup

CreateProperty

CreatePropertyByPosition

Deactivate

DisableCommit

EnableCommit

GetDirectCallerName

GetDirectCreatorName

GetOriginalCallerName

GetOriginalCreatorName

IsCallerInRole

IsInTransaction

IsSecurityEnabled

Item

SetAbort

SetComplete


Properties (Visual Basic)

Group

Property

PropertyByPosition

Value


Language Summary (Visual Basic)

Abort method

Activate method

CanBePooled method

Commit method

Count method

CreateInstance method

CreateInstance method (Transaction Context)

CreateProperty method

CreatePropertyByPosition method

CreatePropertyGroup method

Deactivate method

DisableCommit method

EnableCommit method

GetDirectCallerName method

GetDirectCreatorName method

GetObjectContext function

GetOriginalCallerName method

GetOriginalCreatorName method

Group property

IsCallerInRole method

IsInTransaction method

IsSecurityEnabled method

Item method

ObjectContext object

Property property

PropertyByPosition property

SafeRef function

SecurityProperty object

SetAbort method

SetComplete method

SharedProperty object

SharedPropertyGroup object

SharedPropertyGroupManager object

TransactionContext object

Value property


Functions (Visual C++)

GetObjectContext

SafeRef


Interfaces (Visual C++)

You use the following object in base clients:

ITransactionContext

You use the following objects in components:

IGetContextProperties

IObjectContext

IObjectContextActivity

IObjectControl

ISecurityProperty

ISharedProperty

ISharedPropertyGroup

ISharedPropertyGroupManager


Methods (Visual C++)

Abort

Activate

CanBePooled

Commit

Count

CreateInstance

CreateInstance (Transaction Context)

CreatePropertyGroup

CreateProperty

CreatePropertyByPosition

Deactivate

DisableCommit

EnableCommit

EnumNames

get__NewEnum

get_Group

get_Property

get_PropertyByPosition

get_Value

GetActivityId

GetDirectCallerSID

GetDirectCreatorSID

GetOriginalCallerSID

GetOriginalCreatorSID

GetProperty

IsCallerInRole

IsInTransaction

IsSecurityEnabled

put_Value

ReleaseSID

SetAbort

SetComplete


Language Summary (Visual C++)

Abort method

Activate method

CanBePooled method

Commit method

Count method

CreateInstance method

CreateInstance method (Transaction Context)

CreateProperty method

CreatePropertyByPosition method

CreatePropertyGroup method

Deactivate method

DisableCommit method

EnableCommit method

EnumNames method

get__NewEnum method

get_Group method

get_Property method

get_PropertyByPosition method

get_Value method

GetActivityId method

GetDirectCallerSID method

GetDirectCreatorSID method

GetObjectContext function

GetOriginalCallerSID method

GetOriginalCreatorSID method

GetProperty method

IGetContextProperties interface

IObjectContext interface

IObjectContextActivity interface

IObjectControl interface

IsCallerInRole method

ISecurityProperty interface

ISharedProperty interface

ISharedPropertyGroup interface

ISharedPropertyGroupManager interface

IsInTransaction method

IsSecurityEnabled method

ITransactionContextEx interface

put_Value method

ReleaseSID method

SafeRef function

SetAbort method

SetComplete method


Interfaces (Visual J++)

You use the following object in base clients:

ITransactionContext

You use the following objects in components:

IGetContextProperties

IObjectContext

IObjectControl

ISharedProperty

ISharedPropertyGroup

ISharedPropertyGroupManager


Methods (Visual J++)

Abort

Activate

CanBePooled

Commit

Count

CreateInstance

CreateInstance (Transaction Context)

CreatePropertyGroup

CreateProperty

CreatePropertyByPosition

Deactivate

DisableCommit

EnableCommit

EnumNames

get_NewEnum

getGroup

getProperty

GetProperty

getPropertyByPosition

getValue

IsCallerInRole

IsInTransaction

IsSecurityEnabled

MTx.GetObjectContext

MTx.SafeRef

putValue

SetAbort

SetComplete


Language Summary (Visual J++)

Abort method

Activate method

CanBePooled method

Commit method

Count method

CreateInstance method

CreateInstance method (Transaction Context)

CreateProperty method

CreatePropertyByPosition method

CreatePropertyGroup method

Deactivate method

DisableCommit method

EnableCommit method

EnumNames method

get_NewEnum method

getGroup method

getProperty method

GetProperty method

getPropertyByPosition method

getValue method

IObjectContext interface

IObjectControl interface

IsCallerInRole method

ISharedProperty interface

ISharedPropertyGroup interface

ISharedPropertyGroupManager interface

IsInTransaction method

IsSecurityEnabled method

ITransactionContextEx interface

MTx.GetObjectContext method

MTx.SafeRef method

putValue method

SetAbort method

SetComplete method


IGetContextProperties Interface

The IGetContextProperties interface provides access to context object properties.

Remarks

The header file for the IGetContextProperties interface is mtx.h.

The IGetContextProperties interface exposes the following methods.

Method	Description
Count	Returns the number of properties associated with the context object.
EnumNames	Returns a reference to an enumerator that you can use to iterate through all the context object properties.
GetProperty	Returns a context object property.
See Also

Context Objects


IGetContextProperties::Count Method

Returns the number of context object properties.

Provided By

IGetContextProperties

HRESULT IGetContextProperties::Count (
long * plCount);

Parameters

plCount
[out] The number of properties.

Return Values

S_OK
A valid count is returned in the plCount parameter.

E_INVALIDARG
The valid count could not be returned.

Example


IGetContextProperties::EnumNames Method

Returns a reference to an enumerator that you can use to iterate through all the context object properties.

Provided By

IGetContextProperties

HRESULT IGetContextProperties::EnumNames (

IEnumNames ** ppenum);

Parameters

ppenum
[out] A reference to the IEnumNames interface on a new enumerator object that you can use to iterate through all the context object properties.

Return Values

S_OK
A reference to the requested enumerator is returned in the ppenum parameter.

E_INVALIDARG
The requested enumerator could not be returned.

Remarks

You use the EnumNames method to obtain a reference to an enumerator object. The returned IEnumNames interface exposes several methods you can use to iterate through a list of BSTRs representing context object properties. Once you have a name, you can use the GetProperty method to obtain a reference to the context object property it represents. See the COM documentation for information on enumerators.

As with any COM object, you must release an enumerator object when you're finished using it.

Example


IGetContextProperties::GetProperty Method

Returns a context object property.

Provided By

IGetContextProperties

HRESULT IGetContextProperties::GetProperty (
BSTR	name
VARIANT *	pProperty);

Parameters

name
[in] The name of the context object property to be retrieved.

pProperty
[out] The returned pointer to the property.

Return Values

S_OK
The property was returned successfully.

S_FALSE
The property was not found.

E_INVALIDARG
The name parameter was invalid.

Remarks

You can use GetProperty to retrieve the following Microsoft Internet Information Server (IIS) intrinsic objects:

•	Request

•	Response

•	Server

•	Application

•	Session

For more information, see the IIS documentation.

To retrieve an IIS object, call QueryInterface using the VT_DISPATCH member of the returned VARIANT for the interface to the IIS object (for example IReponse for the Response object).

Note   Context properties are not available in MTS 1.0 server processes.

Example


Count, EnumNames, GetProperty Methods Example

#include "stdafx.h"

#include <initguid.h>

#include "asptlb.h"

#include "mtx.h"

HRESULT hr = NOERROR;

// Get the context object

CComPtr<IObjectContext> pObjectContext;

hr = GetObjectContext(&pObjectContext);

// Get the Response object

CComVariant v;

CComBSTR bstr(L"Response");

CComQIPtr<IGetContextProperties, 	&IID_IGetContextProperties> pProps(pObjectContext);

hr = pProps->GetProperty(bstr, &v);

CComPtr<IDispatch> pDisp;

pDisp = V_DISPATCH(&v);

CComQIPtr<IResponse, &IID_IResponse> pResponse(pDisp);

// Print number of properties

long lCount;

hr = pProps->Count(&lCount);

bstr = L"<p>Number of properties: ";

CComBSTR bstrCount;

VarBstrFromI4(lCount, 0, 0, &bstrCount);

bstr.Append(bstrCount);

bstr.Append(L"</p>");

v = bstr;

hr = pResponse->Write(v);

// Iterate over properties collection and print the

// names of the properties

CComPtr<IEnumNames> pEnum;

CComBSTR bstrTemp;

pProps->EnumNames(&pEnum);

for ( int i = 0; i < lCount; ++i )

{

pEnum->Next(1, &bstr, NULL);

bstrTemp = L"<p>";

bstrTemp.Append(bstr);

bstrTemp.Append(L"</p>");

v = bstrTemp;

hr = pResponse->Write(v);

}


IGetContextProperties Interface

The IGetContextProperties interface provides access to context object properties.

Remarks

The IGetContextProperties interface is declared in the package com.ms.mtx.

The IGetContextProperties interface exposes the following methods.

Method	Description
Count	Returns the number of properties associated with the context object.
EnumNames	Returns a reference to an enumerator that you can use to iterate through all the context object properties.
GetProperty	Returns a context object property.
See Also

Context Objects


IGetContextProperties.Count Method

Returns the number of context object properties.

Provided By

IGetContextProperties

int Count( );

Return Value

The number of properties.

Example


IGetContextProperties.EnumNames Method

Returns a reference to an enumerator that you can use to iterate through all the context object properties.

Provided By

IGetContextProperties

IEnumNames EnumNames ( );

Return Value

A reference to the IEnumNames interface on a new enumerator object that you can use to iterate through the list of all the shared property groups in the process.

Remarks

You use the EnumNames method to obtain a reference to an enumerator object. The returned IEnumNames interface exposes several methods you can use to iterate through a list of string expressions representing context object properties. Once you have a name, you can use the GetProperty method to obtain a reference to the context object property it represents. See the COM documentation for information on enumerators.

Example


IGetContextProperties.GetProperty Method

Returns a context object property.

Provided By

IGetContextProperties

Variant GetProperty(
String name);

Parameters

name
[in] The name of the context object property to be retrieved.

Return Value

The requested context object property.

Remarks

You can use GetProperty to retrieve the following Microsoft Internet Information Server (IIS) intrinsic objects:

•	Request

•	Response

•	Server

•	Application

•	Session

For more information, see the IIS documentation.

To retrieve an IIS object, use the getDispatch method of returned Variant and cast this value to the interface to the IIS object (for example IReponse for the Response object).

Note   Context properties are not available in MTS 1.0 server processes.

Example


Count, EnumNames, GetProperty Methods Example

import com.ms.com.*;

import com.ms.mtx.*;

import asp.*;

// Get the context object

IGetContextProperties icp;

IResponse iresp;

Variant av = new Variant();

icp = (IGetContextProperties)MTx.GetObjectContext();

// Get the Response object

av = icp.GetProperty("Response");

iresp = (IResponse) av.getDispatch();

av.VariantClear();

// Print number of properties

String str;

int pc;

pc = icp.Count();

str = "<p>Number of properties: " + pc + "</p>";

av.putString(str);

iresp.Write (av);

av.VariantClear();

// Iterate over properties collection and print the

// names of the properties

IEnumNames iEnum = null;

int howmany = 1;

String[] names = new String[1];

int fetched;

iEnum = icp.EnumNames();

for ( int i = 0; i < pc; ++i )

{

fetched = iEnum.Next( howmany, names);

str = "<p>" + names[0] + "</p>";

av.putString(str);

iresp.Write (av);

av.VariantClear();

}


ObjectControl Object

You implement the ObjectControl interface when you want to define context-specific initialization and cleanup procedures for your MTS objects and specify whether or not the objects can be recycled. Implementing the ObjectControl interface is optional.

Remarks

To use the ObjectControl object, you must set a reference to the Microsoft Transaction Server Type Library (MTxAS.dll).

If you implement the ObjectControl interface in your component, the MTS run-time environment automatically calls the ObjectControl methods on your objects at the appropriate times.

When an object supports the ObjectControl interface, MTS calls its Activate method once for each time the object is activated. The Activate method is called before any of the object's other methods are called. You can use this method to perform any context-specific initialization an object may require.

MTS calls the object's Deactivate method each time the object is deactivated. This can be the result of the object returning from a method in which it calls SetComplete or SetAbort, or due to the root of the object's transaction, causing the transaction to complete. You use the Deactivate method to clean up state that you initialized in the Activate method.

After calling the Deactivate method, the MTS run-time environment calls the CanBePooled method. If this method returns True, the deactivated object is placed in an object pool for reuse. If the CanBePooled method returns False, the object is released in the usual way.

Note   On systems that don't support object pooling, the value returned by this method is ignored.

The ObjectControl interface is not accessible to an object's clients or to the object itself. Only the MTS run-time environment can invoke the ObjectControl methods.

The ObjectControl interface provides the following methods.

Method	Description
Activate	Allows an object to perform context-specific initialization whenever it's activated. This method is called by the MTS run-time environment before any other methods are called on the object.
CanBePooled	Allows an object to notify the MTS run-time environment of whether it can be pooled for reuse. Return True if you want instances of this component to be pooled, or False if not.
Deactivate	Allows an object to perform whatever cleanup is necessary before it's recycled or destroyed. This method is called by the MTS run-time environment whenever an object is deactivated.
See Also

Deactivating Objects, Object Pooling and Recycling


Activate Method

Implementing this method allows an MTS object to perform context-specific initialization whenever it's activated. This method is called by the MTS run-time environment before any other methods are called on the object.

Applies To

ObjectContext Object

Syntax

objectcontrol.Activate

The objectcontrol placeholder represents is an object variable that evaluates to an ObjectControl object.

Remarks

To use the ObjectControl object, you must set a reference to the Microsoft Transaction Server Type Library (MTxAS.dll).

Whenever a client calls an MTS object that isn't already activated, the MTS run-time environment automatically activates the object. This is called just-in-time activation. For components that support the ObjectControl interface, MTS invokes the object's Activate  method before passing the client's method call on to the object. This allows objects to do context-specific initialization.

If you need to perform any initialization that involves the ObjectContext, you should implement the Activate method and place all your context-specific initialization procedures there.

For example, you can use the Activate method to obtain a reference to an object's context and store it in a member variable. Then the context  is available to any method that requires it, and you don't have to acquire a new one and then release it every time you use it. Once you have a reference to the object's context, you can use the IObjectContext methods to check whether security is enabled, whether the object is executing in a transaction, or whether the caller is in a particular role.

If you're enabling object recycling (returning True from the CanBePooled method), the Activate method must be able to handle both newly created and recycled objects. When the Activate method returns, there should be no distinguishable difference between a new object and a recycled one.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


Activate Method Example

Implements ObjectControl

Dim context As ObjectContext

Option Explicit

Private Sub ObjectControl_Activate()

' Get a reference to the object's context here,

' so it can be used by any method that may be

' called during this activation of the object.

Set context = GetObjectContext()

End Sub


CanBePooled Method

Implementing this method allows an MTS object to notify the MTS run-time environment of whether it can be pooled for reuse. Return True if you want the object to be pooled for reuse, or False if not.

Applies To

ObjectContext Object

Syntax

objectcontrol.CanBePooled (True | False)

The objectcontrol placeholder represents is an object variable that evaluates to an ObjectControl object.

Return Values

True
Notifies the MTS run-time environment that it can pool this object on deactivation for later reuse.

False
Notifies the MTS run-time environment that it should not pool this object on deactivation, but should release its last reference to the object so that the object will be destroyed.

Remarks

To use the ObjectControl object, you must set a reference to the Microsoft Transaction Server Type Library (MTxAS.dll).

When an object returns True from the CanBePooledmethod, it indicates to the MTS run-time environment that it can be added to an object pool after deactivation rather than being destroyed. Whenever an instance is required, one is drawn from the pool rather than created.

The way recycling works is that an object cleans itself up in its Deactivate method and is returned to an object pool. Later, when an instance of the same component is needed, the cleaned up object can be reused. For this to work, an object must be accessible on different threads each time it's activated. Recycling isn't possible under the apartment threading model because, in that model, although an object can be instantiated on any thread, it can only be used by the thread on which it was instantiated. If you want instances of a component to be recyclable, you should register the component with the ThreadingModel Registry value set to Both. This indicates to MTS that the component's objects can be called from different threads.

In MTS, these objects will run under the apartment threading model and won't be recycled even if they return True from the CanBePooled method. However, if you configure a component to support both threading models, the component will run under the current version of MTS and will also be able to take advantage of recycling as soon as it becomes available, without any changes to the code.

Deciding whether to enable recycling is a matter of weighing the costs and benefits. Recycling requires writing additional code, and there's a risk that some state may be inadvertently retained from one activation to the next. When you allow objects to be pooled, you have to be very careful in your Activate  and Deactivate methods to ensure that a recycled object is always restored to a state that's equivalent to the state of a newly created object. Another consideration to take into account is the amount of resources required to maintain an object pool. Objects that hold a lot of resources can be expensive to pool. However, in certain situations, recycling can be extremely efficient, resulting in improved performance and increased scalability. The trade-off is between the cost of holding onto resources while objects are pooled (and inactive) versus the cost of creating and destroying the resources.

It's usually best to enable recycling for objects that cost more to create than they cost to reinitialize. For example, if a component contains a complex structure, and that structure can be reused, it could save a lot of time if the structure didn't have to be recreated every time an instance of the component was activated. This is a case in which you might want to enable recycling, which you would do by returning True from the CanBePooled method.

The Activate method is called whether a new instance is created or a recycled instance is drawn from the pool. Similarly, the Deactivate method is called every time the object is deactivated, whether it's being destroyed or returned to the pool for recycling.

So, in this example, you'd use the object's Activate method to initialize, or reinitialize, the structure that's being reused, and you'd use the Deactivate method to restore the object to a state that the Activate method can handle. (The Activate method must be able to handle both new objects and reused objects drawn from the pool.) This combined use of the Activate, Deactivate, and CanBePooled methods eliminates the need to recreate reusable resources every time an instance is activated.

For some objects, recycling isn't efficient. For example, if an object acquires a lot of state during its lifetime that isn't reusable, and has little to do during its construction, it's usually cheaper to create a new instance whenever one is needed. In that case, you would return False from the CanBePooled method.

Note   Returning True from the CanBePooled method doesn't guarantee that objects will be recycled; it only gives the MTS run-time environment permission to recycle them. On systems that don't support object pooling, a return value of True is ignored. Returning False from the CanBePooled method guarantees that instances of a component aren't recycled.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


CanBePooled Method Example

Implements ObjectControl

Dim context As ObjectContext

Option Explicit

Private Function ObjectControl_CanBePooled() As Boolean

' This object should not be recycled,

' so return false.

ObjectControl_CanBePooled = False

End Function


Deactivate Method

Implementing this method allows an MTS object to perform any cleanup required before it's recycled or destroyed. This method is called by the MTS run-time environment whenever an object is deactivated.

Applies To

ObjectContext Object

Syntax

objectcontrol.Deactivate

The objectcontrol placeholder represents is an object variable that evaluates to an ObjectControl object.

Remarks

To use the ObjectControl object, you must set a reference to the Microsoft Transaction Server Type Library (MTxAS.dll).

The MTS run-time environment calls the Deactivate method whenever an object that supports the ObjectControl interface is deactivated. An object is deactivated when it returns from a method in which it called SetComplete or SetAbort, when the transaction in which it executed is committed or aborted, or when the last client to hold a reference on it releases its reference.

If the component supports recycling (returns True from the CanBePooled method), you should use the Deactivate method to reset the object's state to the state in which the Activate method expects to find it. You can also use the Deactivate method to release the object's ObjectContext or to do other context-specific cleanup. Even if an object supports recycling, it can be beneficial to release certain reusable resources in its Deactivate method. For example, ODBC provides its own connection pooling. It's more efficient to pool a database connection in a general connection pool where it can be used by other objects than it is to keep it tied to a specific object in an object pool.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


Deactivate Method Example

Implements ObjectControl

Dim objcontext As ObjectContext

Option Explicit

Private Sub ObjectControl_Deactivate()

' Perform any necessary cleanup here.

Set objcontext = Nothing

End Sub


IObjectControl Interface

You implement the IObjectControl interface when you want to define context-specific initialization and cleanup procedures for your MTS objects and specify whether or not the objects can be recycled. Implementing the IObjectControl interface is optional.

Remarks

The header file for the IObjectControl interface is mtx.h.

If you implement the IObjectControl interface in your component, the MTS run-time environment automatically calls the IObjectControl methods on your objects at the appropriate times.

When an object supports the IObjectControl interface, MTS calls its Activate method once for each time the object is activated. The Activate method is called before any of the object's other methods are called. You can use this method to perform any context-specific initialization an object may require.

Note   An object's context isn't available during object construction (from the object's class factory), so context-specific initialization can't be performed in an object's constructor.

MTS calls the object's Deactivate method each time the object is deactivated. This can be the result of the object returning from a method in which it calls SetComplete or SetAbort, or due to the root of the object's transaction, causing the transaction to complete. You use the Deactivate method to clean up state that you initialized in the Activate method.

After calling the Deactivate method, the MTS run-time environment calls the CanBePooled method. If this method returns TRUE, the deactivated object is placed in an object pool for reuse. If the CanBePooled method returns FALSE, the object is released in the usual way and its destructor is invoked.

Note   On systems that don't support object pooling, the value returned by this method is ignored.

The IObjectControl interface is not accessible to an object's clients or to the object itself. Only the MTS run-time environment can invoke the IObjectControl methods. If a client queries for the IObjectControl interface, QueryInterface will return E_NOINTERFACE.

The IObjectControl interface exposes the following methods.

Method	Description
Activate	Allows an object to perform context-specific initialization whenever it's activated. This method is called by the MTS run-time environment before any other methods are called on the object.
CanBePooled	Allows an object to notify the MTS run-time environment of whether it can be pooled for reuse. Return TRUE if you want instances of this component to be pooled, or FALSE if not.
Deactivate	Allows an object to perform whatever cleanup is necessary before it's recycled or destroyed. This method is called by the MTS run-time environment whenever an object is deactivated.
See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl::Activate Method

Implementing this method allows an MTS object to perform context-specific initialization whenever it's activated. This method is called by the MTS run-time environment before any other methods are called on the object.

Provided By

IObjectContext

HRESULT IObjectControl::Activate ( );

Return Values

S_OK
The Activate method succeeded.

Failure HRESULT
Any error code indicating why an object was unable to activate itself.

Remarks

Whenever a client calls an MTS object that isn't already activated, the MTS run-time environment automatically activates the object. This is called just-in-time activation. For components that support the IObjectControl interface, MTS invokes the object's Activate method before passing the client's method call on to the object. This allows objects to do context-specific initialization.

Because an object's context isn't available during object construction, you can't perform any initialization that involves the ObjectContextinside the constructor. Instead, you should implement the Activate method and place all your context-specific initialization procedures there.

For example, you can use the Activate method to obtain a reference to an object's context and store it in a member variable. Then the context reference is available to any method that requires it, and you don't have to acquire a new one and then release it every time you use it. Once you have a reference to the object's context, you can use the IObjectContext methods to check whether security is enabled, whether the object is executing in a transaction, or whether the caller is in a particular role. You can also use the Activate method to obtain a reference to the object's SecurityProperty and check the security ID of the object's creator before any methods are called.

If you're enabling object recycling (returning TRUE from the CanBePooled method), the Activate method must be able to handle both newly created and recycled objects. When the Activate method returns, there should be no distinguishable difference between a new object and a recycled one.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl::Activate Method Example

#include <mtx.h>

IObjectContext* m_pObjectContext;

HRESULT MyObject::Activate()

{

// Get a reference to the object's context here,

// so it can be used by any method that may be

// called during this activation of the object.

HRESULT hr = GetObjectContext(&m_pObjectContext);

if (SUCCEEDED(hr))

return S_OK;

return hr;

}


IObjectControl::CanBePooled Method

Implementing this method allows an MTS object to notify the MTS run-time environment of whether it can be pooled for reuse. Return TRUE if you want the object to be pooled for reuse, or FALSE if not.

Provided By

IObjectContext

BOOL IObjectControl::CanBePooled ( );

Return Values

TRUE
Notifies the MTS run-time environment that it can pool this object on deactivation for later reuse.

FALSE
Notifies the MTS run-time environment that it should not pool this object on deactivation, but should release its last reference to the object so that the object will be destroyed.

Remarks

When an object returns TRUE from the CanBePooledmethod, it indicates to the MTS run-time environment that it can be added to an object pool after deactivation rather than being destroyed. Whenever an instance is required, one is drawn from the pool rather than created by the class factory.

The way recycling works is that an object cleans itself up in its Deactivate method and is returned to an object pool. Later, when an instance of the same component is needed, the cleaned up object can be reused. For this to work, an object must be accessible on different threads each time it's activated. Recycling isn't possible under the apartment threading model because, in that model, although an object can be instantiated on any thread, it can only be used by the thread on which it was instantiated. If you want instances of a component to be recyclable, you should register the component with the ThreadingModel Registry value set to Both. This indicates to MTS that the component's objects can be called from different threads.

In MTS, these objects will run under the apartment threading model and won't be recycled even if they return TRUE from the CanBePooled method. However, if you configure a component to support both threading models, the component will run under the current version of MTS and will also be able to take advantage of recycling as soon as it becomes available, without any changes to the code.

Deciding whether to enable recycling is a matter of weighing the costs and benefits. Recycling requires writing additional code, and there's a risk that some state may be inadvertently retained from one activation to the next. When you allow objects to be pooled, you have to be very careful in your Activate and Deactivate methods to ensure that a recycled object is always restored to a state that's equivalent to the state of a newly created object. Another consideration to take into account is the amount of resources required to maintain an object pool. Objects that hold a lot of resources can be expensive to pool. However, in certain situations, recycling can be extremely efficient, resulting in improved performance and increased scalability. The trade-off is between the cost of holding onto resources while objects are pooled (and inactive) versus the cost of creating and destroying the resources.

It's usually best to enable recycling for objects that cost more to create than they cost to reinitialize. For example, if a component contains a complex structure, and that structure can be reused, it could save a lot of time if the structure didn't have to be recreated every time an instance of the component was activated. This is a case in which you might want to enable recycling, which you would do by returning TRUE from the CanBePooled method.

You could still create the structure in the object's constructor and release it in the destructor. The constructor is only called once, when a new object is created by the class factory. When recycling is enabled, that only happens when the object pool is empty. The Activate method, on the other hand, is called whether a new instance is created by the class factory or a recycled instance is drawn from the pool. Similarly, the object's destructor is only called when no further instances are needed, for example, when the server is shutting down. The Deactivate method is called every time the object is deactivated, whether it's being destroyed or returned to the pool for recycling.

So, in this example, you'd use the object's Activate method to initialize, or reinitialize, the structure that's being reused, and you'd use the Deactivate method to restore the object to a state that the Activate method can handle. (The Activate method must be able to handle both new objects created by the class factory and reused objects drawn from the pool.) This combined use of the Activate, Deactivate, and CanBePooled methods eliminates the need to recreate reusable resources every time an instance is activated.

For some objects, recycling isn't efficient. For example, if an object acquires a lot of state during its lifetime that isn't reusable, and has little to do during its construction, it's usually cheaper to create a new instance whenever one is needed. In that case, you would return FALSE from the CanBePooled method.

Note   Returning TRUE from the CanBePooled method doesn't guarantee that objects will be recycled; it only gives the MTS run-time environment permission to recycle them. On systems that don't support object pooling, a return value of TRUE is ignored. Returning FALSE from the CanBePooled method guarantees that instances of a component aren't recycled.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl::CanBePooled Method Example

#include <mtx.h>

BOOL MyObject::CanBePooled()

{

// This object should not be recycled,

// so return false.

return FALSE;

}


IObjectControl::Deactivate Method

Implementing this method allows an MTS object to perform any cleanup required before it's recycled or destroyed. This method is called by the MTS run-time environment whenever an object is deactivated.

Provided By

IObjectContext

void IObjectControl::Deactivate ( );.

Remarks

The MTS run-time environment calls the Deactivate method whenever an object that supports the IObjectControl interface is deactivated. An object is deactivated when it returns from a method in which it called SetComplete or SetAbort, when the transaction in which it executed is committed or aborted, or when the last client to hold a reference on it releases its reference.

If the component supports recycling (returns TRUE from the CanBePooled method), you should use the Deactivate method to reset the object's state to the state in which the Activatemethod expects to find it. You can also use the Deactivate method to release the object's ObjectContext reference or to do other context-specific cleanup. You can't do this in the Release method or the destructor, because the IObjectContext interface isn't accessible from the destructor or any of the IUnknown methods. Even if an object supports recycling, it can be beneficial to release certain reusable resources in its Deactivate method. For example, ODBC provides its own connection pooling. It's more efficient to pool a database connection in a general connection pool where it can be used by other objects than it is to keep it tied to a specific object in an object pool.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl::Deactivate Method Example

#include <mtx.h>

void MyObject::Deactivate(void)

{

// This object is no longer associated with this

// context, so release the reference it acquired in

// its Activate method.

m_pObjectContext->Release();

}


IObjectControl Interface

You implement the IObjectControl interface when you want to define context-specific initialization and cleanup procedures for your MTS objects and specify whether or not the objects can be recycled. Implementing the IObjectControl interface is optional.

Remarks

The IObjectControl interface is declared in the package com.ms.mtx.

If you implement the IObjectControl interface in your component, the MTS run-time environment automatically calls the IObjectControl methods on your objects at the appropriate times.

When an object supports the IObjectControl interface, MTS calls its Activate method once for each time the object is activated. The Activate method is called before any of the object's other methods are called. You can use this method to perform any context-specific initialization an object may require.

Note   An object's context isn't available during object construction (from the object's class factory), so context-specific initialization can't be performed in an object's constructor.

MTS calls the object's Deactivate method each time the object is deactivated. This can be the result of the object returning from a method in which it calls SetComplete or SetAbort, or due to the root of the object's transaction, causing the transaction to complete. You use the Deactivate method to clean up state that you initialized in the Activate method.

After calling the Deactivate method, the MTS run-time environment calls the CanBePooled method. If this method returns true, the deactivated object is placed in an object pool for reuse. If the CanBePooled method returns false, the object is released in the usual way.

Note   On systems that don't support object pooling, the value returned by this method is ignored.

The IObjectControl interface is not accessible to an object's clients or to the object itself. Only the MTS run-time environment can invoke the IObjectControl methods.

The IObjectControl interface exposes the following methods.

Method	Description
Activate	Allows an object to perform context-specific initialization whenever it's activated. This method is called by the MTS run-time environment before any other methods are called on the object.
CanBePooled	Allows an object to notify the MTS run-time environment of whether it can be pooled for reuse. Return true if you want instances of this component to be pooled, or false if not.
Deactivate	Allows an object to perform whatever cleanup is necessary before it's recycled or destroyed. This method is called by the MTS run-time environment whenever an object is deactivated.
See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl.Activate Method

Implementing this method allows an MTS object to perform context-specific initialization whenever it's activated. This method is called by the MTS run-time environment before any other methods are called on the object.

Provided By

IObjectContext

void Activate ( );

Remarks

Whenever a client calls an MTS object that isn't already activated, the MTS run-time environment automatically activates the object. This is called just-in-time activation. For components that support the IObjectControl interface, MTS invokes the object's Activate method before passing the client's method call on to the object. This allows objects to do context-specific initialization.

Because an object's context isn't available during object construction, you can't perform any initialization that involves the ObjectContextinside the constructor. Instead, you should implement the Activate method and place all your context-specific initialization procedures there.

For example, you can use the Activate method to obtain a reference to an object's context and store it in a member variable. Then the context reference is available to any method that requires it, and you don't have to acquire a new one and then release it every time you use it. Once you have a reference to the object's context, you can use the IObjectContext methods to check whether security is enabled, whether the object is executing in a transaction, or whether the caller is in a particular role.

If you're enabling object recycling (returning true from the CanBePooled method), the Activate method must be able to handle both newly created and recycled objects. When the Activate method returns, there should be no distinguishable difference between a new object and a recycled one.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl.Activate Method Example

import com.ms.mtx.*;

void Activate()

{

// Get a reference to the object's context here,

// so it can be used by any method that may be

// called during this activation of the object.

m_ObjectContext = MTx.GetObjectContext()

}


IObjectControl.CanBePooled Method

Implementing this method allows an MTS object to notify the MTS run-time environment of whether it can be pooled for reuse. Return true if you want the object to be pooled for reuse, or false if not.

Provided By

IObjectContext

boolean CanBePooled ( );

Return Values

true
Notifies the MTS run-time environment that it can pool this object on deactivation for later reuse.

false
Notifies the MTS run-time environment that it should not pool this object on deactivation, but should release its last reference to the object so that the object will be destroyed.

Remarks

When an object returns true from the CanBePooledmethod, it indicates to the MTS run-time environment that it can be added to an object pool after deactivation rather than being destroyed. Whenever an instance is required, one is drawn from the pool rather than created by the class factory.

The way recycling works is that an object cleans itself up in its Deactivate method and is returned to an object pool. Later, when an instance of the same component is needed, the cleaned up object can be reused. For this to work, an object must be accessible on different threads each time it's activated. Recycling isn't possible under the apartment threading model because, in that model, although an object can be instantiated on any thread, it can only be used by the thread on which it was instantiated. If you want instances of a component to be recyclable, you should register the component with the ThreadingModel Registry value set to Both. This indicates to MTS that the component's objects can be called from different threads.

In MTS, these objects will run under the apartment threading model and won't be recycled even if they return true from the CanBePooled method. However, if you configure a component to support both threading models, the component will run under the current version of MTS and will also be able to take advantage of recycling as soon as it becomes available, without any changes to the code.

Deciding whether to enable recycling is a matter of weighing the costs and benefits. Recycling requires writing additional code, and there's a risk that some state may be inadvertently retained from one activation to the next. When you allow objects to be pooled, you have to be very careful in your Activate and Deactivate methods to ensure that a recycled object is always restored to a state that's equivalent to the state of a newly created object. Another consideration to take into account is the amount of resources required to maintain an object pool. Objects that hold a lot of resources can be expensive to pool. However, in certain situations, recycling can be extremely efficient, resulting in improved performance and increased scalability. The trade-off is between the cost of holding onto resources while objects are pooled (and inactive) versus the cost of creating and destroying the resources.

It's usually best to enable recycling for objects that cost more to create than they cost to reinitialize. For example, if a component contains a complex structure, and that structure can be reused, it could save a lot of time if the structure didn't have to be recreated every time an instance of the component was activated. This is a case in which you might want to enable recycling, which you would do by returning true from the CanBePooled method.

You could still create the structure in the object's constructor because the constructor is only called once, when a new object is created by the class factory. When recycling is enabled, that only happens when the object pool is empty. The Activate method, on the other hand, is called whether a new instance is created by the class factory or a recycled instance is drawn from the pool. Similarly, the Deactivate method is called every time the object is deactivated, whether it's being destroyed or returned to the pool for recycling.

So, in this example, you'd use the object's Activate method to initialize, or reinitialize, the structure that's being reused, and you'd use the Deactivate method to restore the object to a state that the Activate method can handle. (The Activate method must be able to handle both new objects created by the class factory and reused objects drawn from the pool.) This combined use of the Activate, Deactivate, and CanBePooled methods eliminates the need to recreate reusable resources every time an instance is activated.

For some objects, recycling isn't efficient. For example, if an object acquires a lot of state during its lifetime that isn't reusable, and has little to do during its construction, it's usually cheaper to create a new instance whenever one is needed. In that case, you would return false from the CanBePooled method.

Note   Returning true from the CanBePooled method doesn't guarantee that objects will be recycled; it only gives the MTS run-time environment permission to recycle them. On systems that don't support object pooling, a return value of true is ignored. Returning false from the CanBePooled method guarantees that instances of a component aren't recycled.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl.CanBePooled Method Example

import com.ms.mtx.*;

boolean CanBePooled()

{

// This object should not be recycled,

// so return false.

return false;

}


IObjectControl.Deactivate Method

Implementing this method allows an MTS object to perform any cleanup required before it's recycled or destroyed. This method is called by the MTS run-time environment whenever an object is deactivated.

Provided By

IObjectContext

void Deactivate ( );.

Remarks

The MTS run-time environment calls the Deactivate method whenever an object that supports the IObjectControl interface is deactivated. An object is deactivated when it returns from a method in which it called SetComplete or SetAbort, when the transaction in which it executed is committed or aborted, or when the last client to hold a reference on it releases its reference.

If the component supports recycling (returns true from the CanBePooled method), you should use the Deactivate method to reset the object's state to the state in which the Activatemethod expects to find it. You can also use the Deactivate method to release the object's ObjectContext reference or to do other context-specific cleanup. Even if an object supports recycling, it can be beneficial to release certain reusable resources in its Deactivate method. For example, ODBC provides its own connection pooling. It's more efficient to pool a database connection in a general connection pool where it can be used by other objects than it is to keep it tied to a specific object in an object pool.

Example

See Also

Deactivating Objects, Object Pooling and Recycling


IObjectControl.Deactivate Method Example

import com.ms.mtx.*;

void Deactivate( )

{

// Perform any necessary cleanup here.

}


SafeRef Function

Used by an object to obtain a reference to itself that's safe to pass outside its context.

Syntax

Set safeobject = SafeRef(Me)

Part

safeobject
An object variable representing the current object that's safe to pass to another object or client.

Remarks

When an MTS object wants to pass a self-reference to a client or another object (for example, for use as a callback), it should always call SafeRef first and then pass the reference returned by this call.

To use the SafeRef function, you must set a reference to Microsoft Transaction Server Type Library (mtxas.dll).

Example

See Also

Passing Object References


SafeRef Function Example

Dim anotherObject As New ObjectThatCallsBack

Dim safeMe As My.Class

' Get a safe reference.

Set safeMe = SafeRef(Me)

' Invoke a method on another object, passing the

' safe reference so it can call back.

If Not safeMe Is Nothing Then

Call anotherObject.CallMeBack(safeMe)

Set safeMe = Nothing


GetObjectContext Function

Obtains a reference to the ObjectContext that's associated with the current MTS object.

To use the GetObjectContext function, you must set a reference to Microsoft Transaction Server Type Library (mtxas.dll).

Syntax

Set objectcontext = GetObjectContext ( )

Parameters

objectcontext
An object variable that evaluates to the ObjectContext belonging to the current object.

Remarks

An object should never attempt to pass its ObjectContext reference to another object. If you pass an ObjectContext reference to another object, it will no longer be a valid reference.

When an object obtains a reference to its ObjectContext, it must release the ObjectContext object when it's finished with it.

Example

See Also

Building Scalable Components, Context Objects, CreateInstance Method


GetObjectContext Function, CreateInstance Method Example

Dim ctxObject As ObjectContext

Dim objAccount As Bank.Account

' Get the object's ObjectContext.

Set ctxObject = GetObjectContext()

' Use it to instantiate another object.

Set objAccount = _

ctxObject.CreateInstance("Bank.Account")


ObjectContext Object

The ObjectContext object provides access to the current object's context.

Remarks

To use the ObjectContext object, you must set a reference to Microsoft Transaction Server Type Library (mtxas.dll).

You obtain a reference to the ObjectContext object by calling the GetObjectContext function. As with any COM object, you must release an ObjectContext object when you're finished using it, unless it's a local variable.

You can use an object's ObjectContext to:

•	Declare that the object's work is complete.

•	Prevent a transaction from being committed, either temporarily or permanently.

•	Instantiate other MTS objects and include their work within the scope of the current object's transaction.

•	Find out if a caller is in a particular role.

•	Find out if security is enabled.

•	Find out if the object is executing within a transaction.

•	Retrieve Microsoft Internet Information Server (IIS) built-in objects.

The ObjectContext object provides the following methods.

Method	Description
Count	Returns the number of context object properties.
CreateInstance	Instantiates another MTS object.
DisableCommit	Declares that the object hasn't finished its work and that its transactional updates are in an inconsistent state. The object retains its state across method calls, and any attempts to commit the transaction before the object calls EnableCommit or SetComplete will result in the transaction being aborted.
EnableCommit	Declares that the object's work isn't necessarily finished, but its transactional updates are in a consistent state. This method allows the transaction to be committed, but the object retains its state across method calls until it calls SetComplete or SetAbort, or until the transaction is completed.
IsCallerInRole	Indicates whether the object's direct caller is in a specified role (either directly or as part of a group).
IsInTransaction	Indicates whether the object is executing within a transaction.
IsSecurityEnabled	Indicates whether security is enabled. MTS security is enabled unless the object is running in the client's process.
Item	Returns a context object property.
Security	Returns a reference to an object's SecurityProperty object.
SetAbort	Declares that the object has completed its work and can be deactivated on returning from the currently executing method, but that its transactional updates are in an inconsistent state or that an unrecoverable error occurred. This means that the transaction in which the object was executing must be aborted. If any object executing within a transaction returns to its client after calling SetAbort, the entire transaction is doomed to abort.
SetComplete	Declares that the object has completed its work and can be deactivated on returning from the currently executing method. For objects that are executing within the scope of a transaction, it also indicates that the object's transactional updates can be committed. When an object that is the root of a transaction calls SetComplete, MTS attempts to commit the transaction on return from the current method.
Note   When an object calls DisableCommit, EnableCommit, SetComplete, or SetAbort from within a method, two flags (Done and Consistent) are set in its ObjectContext. (See the following table for an explanation.) These flags aren't evaluated by the MTS run-time environment until the object's currently executing method returns to its caller. This means that an object can call these methods any number of times from within one of its own methods, but the last call before the object returns to its client is the one that will be in effect.

Method	Done	Consistent
SetAbort	TRUE	FALSE
SetComplete	TRUE	TRUE
DisableCommit	FALSE	FALSE
EnableCommit	FALSE	TRUE
The Done flag, which allows an object to be deactivated and its transaction to commit or abort, is only evaluated after the object returns from the call that first entered its context. For example, suppose client A calls into object B. Object B calls SetComplete and then calls into object C (passing it a safe reference for a callback). Object C calls back to object B, and then object B returns to client A. Object B won't be deactivated when it returns to object C; it will be deactivated when it returns to client A.

See Also

Basic Security Methods, Passing Object References, Context Objects, Transactions, Deactivating Objects


Count Method

Returns the number of context object properties.

Applies To

ObjectContext Object

Syntax

objectcontext.Count

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Return Value

The number of properties.

Example


CreateInstance Method

Instantiates an MTS object.

Applies To

ObjectContext Object

Syntax

Set object = objectcontext.CreateInstance("progID")

Part

object
An object variable that evaluates to an MTS object.

objectcontext
An object variable that represents the ObjectContext from which to instantiate the new object.

progID
A string expression that is the programmatic ID of the new object's component.

Remarks

CreateInstance creates a COM object. However, the object will have context only if its component is registered with MTS.

When you create an object by using CreateInstance, the new object's context is derived from the current object's ObjectContext and the declarative properties of the new object's component. The new object always executes within the same activity as the object that created it. If the current object has a transaction, the transaction attribute of the new object's component determines whether or not the new object will execute within the scope of that transaction.

If the component's transaction attribute is set to either Requires a transaction or Supports transactions, the new object inherits its creator's transaction. If the component's transaction attribute is set to Requires a new transaction, MTS initiates a new transaction for the new object. If the component's transaction attribute is set to Does not support transactions, the new object doesn't execute under any transaction.

Example

See Also

Creating MTS Objects, Transaction Attributes, MTS Component Requirements


DisableCommit Method

Declares that the object's transactional updates are inconsistent and can't be committed in their present state.

Applies To

ObjectContext Object

Syntax

objectcontext.DisableCommit

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Remarks

An object that invokes DisableCommit is stateful.

You can use the DisableCommit method to prevent a transaction from committing prematurely between method calls in a stateful object. When an object invokes DisableCommit, it indicates that its work is inconsistent and that it can't complete its work until it receives further method invocations from the client. It also indicates that it needs to maintain its state to perform that work. This prevents the MTS run-time environment from deactivating the object and reclaiming its resources on return from a method call. Once an object has called DisableCommit, if a client attempts to commit the transaction before the object has called EnableCommit or SetComplete, the transaction will abort.

For example, suppose you have a General Ledger component that updates a database. A client makes multiple calls to a General Ledger object to post entries to various accounts. There's an integrity constraint that says the debits must equal the credits when the final method invocation returns, or the transaction must abort. The General Ledger object has an initialization method in which the client informs it of the sequence of calls the client is going to make, and the General Ledger object calls DisableCommit. The object maintains its state between calls so that after the final call in the sequence is made the object can make sure the integrity constraint is satisfied before allowing its work to be committed.

Example

See Also

Transactions


DisableCommit Method Example

Dim objContext As ObjectContext

Set objContext = GetObjectContext()

objContext.DisableCommit


EnableCommit Method

Declares that the current object's work is not necessarily finished, but that its transactional updates are consistent and could be committed in their present form.

Applies To

ObjectContext Object

Syntax

objectcontext.EnableCommit

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Remarks

When an object calls EnableCommit, it allows the transaction in which it's participating to be committed, but it maintains its internal state across calls from its clients until it calls SetComplete or SetAbort or until the transaction completes.

EnableCommit is the default state when an object is activated. This is why an object should always call SetComplete or SetAbort before returning from a method, unless you want the object to maintain its internal state for the next call from a client.

Example

See Also

Transactions


EnableCommit Method Example

Dim objContext As ObjectContext

Set objContext = GetObjectContext()

objContext.EnableCommit


IsCallerInRole Method

Indicates whether an object's direct caller is in a specified role (either individually or as part of a group).

Applies To

ObjectContext Object

Syntax

objectcontext.IsCallerInRole(role)

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Parameters

objectcontext
An object variable that represents the ObjectContext belonging to the current object.

role
A string expression that contains the name of the role in which to determine if the caller is acting.

Return Values

True
Either the caller is in the specified role, or security is not enabled.

False
The caller is not in the specified role.

Remarks

You use this method to determine whether the direct caller of the currently executing method is associated with a specific role. A role is a symbolic name that represents a user or group of users who have specific access permissions to all components in a given package. Developers define roles when they create a component, and roles are mapped to individual users or groups at deployment time.

IsCallerInRole only applies to the direct caller of the currently executing method. (The direct caller is the process calling into the current server process. It can be either a base client process or a server process.) IsCallerInRole doesn't apply to the process that initiated the call sequence from which the current method was called, or to any other callers in that sequence.

Because IsCallerInRole returns True when the object that invokes it is executing in a client's process, it's a good idea to call IsSecurityEnabled before calling IsCallerInRole. If security isn't enabled, IsCallerInRole won't return an accurate result.

Example

See Also

Programmatic Security, Basic Security Methods, Secured Components


IsCallerInRole, IsSecurityEnabled Methods Example

Dim objContext As ObjectContext

Set objContext = GetObjectContext()

If Not objContext Is Nothing Then

' Find out if Security is enabled.

If objContext.IsSecurityEnabled Then

' Find out if the caller is in the right role.

If Not objContext.IsCallerInRole("Manager") Then

' If not, do something appropriate here.

Else

' If so, execute the call normally.

End If

Else

' If security's not enabled, do something

' appropriate here.

End If

End If


IsInTransaction Method

Indicates whether the current object is executing in a transaction.

Applies To

ObjectContext Object

Syntax

objectcontext.IsInTransaction

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Return Values

True
The current object is executing within a transaction.

False
The current object is not executing within a transaction.

Remarks

You can use this method to make sure that an object that requires a transaction never runs without one. For example, if a component that requires a transaction is improperly configured in the MTS Explorer, you can use this method to determine that the object doesn't have a transaction. Then you can return an error to alert the user to the problem, or take whatever action is appropriate.

Example

See Also

Transaction Attributes, Transactions


IsInTransaction Method Example

Dim objContext As ObjectContext

Set objContext = GetObjectContext()

If Not objContext Is Nothing Then

' Find out if the object is in a transaction.

If Not objContext.IsInTransaction Then

' If not, do something appropriate here.

End If

End If


IsSecurityEnabled Method

Indicates whether or not security is enabled for the current object. MTS security is enabled unless the object is running in the client's process.

Applies To

ObjectContext Object

Syntax

objectcontext.IsSecurityEnabled

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Return Values

True
Security is enabled for this object.

False
Security is not enabled for this object.

Remarks

MTS security is enabled only if an object is running in a server process. This could be either because the object's component was configured to run in a client's process, or because the component and the client are in the same package. If the object is running in the client's process, there is no security checking and IsSecurityEnabled will always return False.

Example

See Also

Programmatic Security, Basic Security Methods, Secured Components


Item Method

Returns a context object property.

Applies To

ObjectContext Object

Syntax

objectcontext.Item(name)

Part

objectcontext
An object variable that evaluates to the ObjectContext associated with the current object.

name
The name of the context object property to be retrieved.

Return Value

The requested context object property.

Remarks

You can use Item to retrieve the following Microsoft Internet Information Server (IIS) built-in objects:

•	Request

•	Response

•	Server

•	Application

•	Session

For more information, see the IIS documentation.

The Item method is the default method for a collection. Therefore, the following lines of code are equivalent:

oc("Response").Write "<p>" & prop & "</p>"

oc.Item("Response").Write "<p>" & prop & "</p>"

Example


Count, Item Methods Example

' Get the context object

Dim oc As ObjectContext

Dim str As String

Set oc = GetObjectContext()

' Get the Response object

' Print number of properties

oc("Response").Write "<p>Number of properties: " & oc.Count & "</p>"

' Iterate over properties collection and print the

' names of the properties

For Each prop In oc

    oc("Response").Write "<p>" & prop & "</p>"

Next


Security Property

Returns a reference to an object's SecurityProperty object.

Applies To

ObjectContext Object

Syntax

Set objectsecurity = objectcontext.Security

Part

objectcontext
An object variable that evaluates to the ObjectContext associated with the current object.

objectsecurity
An object variable that evaluates to the SecurityProperty object associated with the current object.

Example

See Also

Programmatic Security, Advanced Security Methods


Security Property Example

Public Function UsingSecurityMethod() As String

    Dim objCtx As ObjectContext

    Dim objSP As SecurityProperty

    Set objCtx = GetObjectContext()

    Set objSP = objCtx.Security

    UsingSecurityMethod = _

        objSP.GetOriginalCreatorName()

End Function


SetAbort Method

Declares that the transaction in which the object is executing must be aborted, and that the object should be deactivated on returning from the currently executing method call.

Applies To

ObjectContext Object

Syntax

objectcontext.SetAbort

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Remarks

The object is deactivated automatically on return from the method in which it called SetAbort. If the object is the root of an automatic transaction, MTS aborts the transaction. If the object is transactional, but not the root of an automatic transaction, the transaction in which it's participating is doomed to abort. (An object is the root of a transaction if the MTS run-time environment has to initiate a new transaction for it. This is the case when the component that provides the object is configured to require a transaction and the object's creator doesn't have one, or when the component is configured to require a new transaction.)

You can call SetAbort in error handlers to ensure that a transaction aborts when an error occurs. You can also call SetAbort at the beginning of a method to protect your object from committing prematurely in the event of an unexpected return and then call SetComplete just before the method returns, if all goes well.

Example

See Also

Transactions, Context Objects, Deactivating Objects


SetAbort, SetComplete Methods Example

Dim ctxObject As ObjectContext

Set ctxObject = GetObjectContext()

On Error GoTo ErrorHandler

' Do some work here. If the work was successful,

' call SetComplete.

ctxObject.SetComplete

Set ctxObject = Nothing

Perform = 0

Exit Function

' If an error occurred, call SetAbort in the error

' handler.

ErrorHandler:

ctxObject.SetAbort

Set ctxObject = Nothing

Perform = -1

Exit Function


SetComplete Method

Declares that the current object has completed its work and should be deactivated when the currently executing method returns to the client. For objects that are executing within the scope of a transaction, it also indicates that the object's transactional updates can be committed.

Applies To

ObjectContext Object

Syntax

objectcontext.SetComplete

The objectcontext placeholder represents an object variable that evaluates to the ObjectContext associated with the current object.

Remarks

The object is deactivated automatically on return from the method in which it called SetComplete. If the object is the root of an automatic transaction, MTS attempts to commit the transaction. However, if any object that was participating in the transaction has called SetAbort, or has called DisableCommit and has not subsequently called EnableCommit or SetComplete, the transaction will be aborted. (An object is the root of a transaction if the MTS run-time environment has to initiate a new transaction for it. This is the case when the component that provides the object is configured to require a transaction and the object's creator doesn't have one, or when the component is configured to require a new transaction.)

If an object doesn't need to maintain its state after it returns from a method call, it should call SetComplete so that it can be automatically deactivated as soon as it returns and its resources can be reclaimed.

Example

See Also

Transactions, Context Objects, Deactivating Objects


SafeRef Function

Used by an object to obtain a reference to itself that's safe to pass outside its context.

The header file for the SafeRef function is mtx.h.

void* SafeRef (

REFIID riid

UNKNOWN* pUnk

);

Parameter

riid
[in] A reference to the interface ID of the interface that the current object wants to pass to another object or client.

pUnk
[in] A reference to an interface on the current object.

Return Values

Non-NULL
A pointer to the interface specified in the riid parameter that's safe to pass outside the current object's context.

NULL
The object is requesting a safe reference on an object other than itself, or the interface requested in the riid parameter is not implemented.

Remarks

When an MTS object wants to pass a self-reference to a client or another object (for example, for use as a callback), it should always call SafeRef first and then pass the reference returned by this call. An object should never pass a  this pointer, or a self-reference obtained through an internal call to QueryInterface, to a client or to any other object. Once such a reference is passed outside the object's context, it's no longer a valid reference.

Calling SafeRef on a reference that is already safe returns the safe reference unchanged, except that the reference count on the interface is incremented.

When a client calls QueryInterface on a reference that's safe, MTS automatically ensures that the reference returned to the client is also a safe reference.

An object that obtains a safe reference must release the safe reference when it's finished with it.

Note   Safe references have different pointer values than their unsafe counterparts. For example, this and the safe version of this do not have the same value. It's important to be aware of this when testing whether two pointers refer to the same object. Calling QueryInterface for IID_IUnknown on each of the pointers and comparing the value of the returned pointers may result in the wrong conclusion. It's possible that both pointers refer to the same object, but that one is a safe reference and the other isn't. If both references are safe references, they can be compared in the usual way. This is only a consideration for MTS objects, because clients should never have access to unsafe references.

Example

See Also

Passing Object References


SafeRef Function Example

#include <mtx.h>

IMyInterface* pSafeMyObject = NULL;

IAnotherObject* pOtherObject = NULL;

HRESULT hr;

// Get a safe reference.

pSafeMyObject = SafeRef(IID_IMyInterface,

(IUnknown*)this);

// Invoke a method on another object, passing the

// safe reference so it can call back.

hr = pOtherObject->CallMeBack(pSafeMyObject);

// Release the safe reference.

safeMyObject->Release();


GetObjectContext Function

Obtains a reference to the IObjectContext interface on the ObjectContext that's associated with the current MTS object.

The header file for the GetObjectContext function is mtx.h.

HRESULT GetObjectContext (

IObjectContext** ppInstanceContext

);

Parameters

ppInstanceContext
[out] A reference to the IObjectContext interface on the object's context. If the object's component hasn't been imported into an MTS package, or if GetObjectContext is called from a constructor or an IUnknown method, this will be set to a NULL pointer.

Return Values

S_OK
A reference to the IObjectContext interface on the current object's context is returned in the ppInstanceContext parameter.

E_INVALIDARG
The argument passed in the ppInstanceContext parameter is invalid.

E_UNEXPECTED
An unexpected error occurred.

CONTEXT_E_NOCONTEXT
The current object doesn't have a context associated with it, because either the component wasn't imported into a package or the object wasn't created with one of the MTS CreateInstance methods. This error will also be returned if the GetObjectContext method was called from the constructor or from an IUnknown method.

Remarks

An object's context is not accessible from an object's constructor or from any IUnknown method (QueryInterface, AddRef, or Release).

An object should never attempt to pass its ObjectContext reference to another object. If you pass an ObjectContext reference to another object, it will no longer be a valid reference.

When an object obtains a reference to its ObjectContext, it must release the ObjectContext object when it's finished with it.

Example

See Also

Building Scalable Components, Context Objects, IObjectContext::CreateInstance Method


GetObjectContext Function, IObjectContext::CreateInstance Method Example

#include <mtx.h>

IObjectContext* pObjectContext = NULL;

IAccount* pAccount = NULL;

HRESULT hr;

// Get the object's ObjectContext.

hr = GetObjectContext(&pObjectContext);

// Use it to instantiate another object.

hr = pObjectContext->CreateInstance(CLSID_CAccount,

IID_IAccount, (void**)&pAccount);


IObjectContext Interface

The IObjectContext interface provides access to the current object's context.

Remarks

The header file for the IObjectContext interface is mtx.h.

You obtain a reference to the IObjectContext interface by calling the GetObjectContext function. As with any COM object, you must release an ObjectContext object when you're finished using it.

You can use an object's ObjectContext to:

•	Declare that the object's work is complete.

•	Prevent a transaction from being committed, either temporarily or permanently.

•	Instantiate other MTS objects and include their work within the scope of the current object's transaction.

•	Find out if a caller is in a particular role.

•	Find out if security is enabled.

•	Find out if the object is executing within a transaction.

The IObjectContext interface exposes the following methods.

Method	Description
CreateInstance	Instantiates another MTS object.
DisableCommit	Declares that the object hasn't finished its work and that its transactional updates are in an inconsistent state. The object retains its state across method calls, and any attempts to commit the transaction before the object calls EnableCommit or SetComplete will result in the transaction being aborted.
EnableCommit	Declares that the object's work isn't necessarily finished, but its transactional updates are in a consistent state. This method allows the transaction to be committed, but the object retains its state across method calls until it calls SetComplete or SetAbort, or until the transaction is completed.
IsCallerInRole	Indicates whether the object's direct caller is in a specified role (either directly or as part of a group).
IsInTransaction	Indicates whether the object is executing within a transaction.
IsSecurityEnabled	Indicates whether security is enabled. MTS security is enabled unless the object is running in the client's process.
SetAbort	Declares that the object has completed its work and can be deactivated on returning from the currently executing method, but that its transactional updates are in an inconsistent state or that an unrecoverable error occurred. This means that the transaction in which the object was executing must be aborted. If any object executing within a transaction returns to its client after calling SetAbort, the entire transaction is doomed to abort.
SetComplete	Declares that the object has completed its work and can be deactivated on returning from the currently executing method. For objects that are executing within the scope of a transaction, it also indicates that the object's transactional updates can be committed. When an object that is the root of a transaction calls SetComplete, MTS attempts to commit the transaction on return from the current method.
Note   When an object calls DisableCommit, EnableCommit, SetComplete, or SetAbort from within a method, two flags (Done and Consistent) are set in its ObjectContext. (See the following table for an explanation.) These flags aren't evaluated by the MTS run-time environment until the object's currently executing method returns to its caller. This means that an object can call these methods any number of times from within one of its own methods, but the last call before the object returns to its client is the one that will be in effect.

Method	Done	Consistent
SetAbort	TRUE	FALSE
SetComplete	TRUE	TRUE
DisableCommit	FALSE	FALSE
EnableCommit	FALSE	TRUE
The Done flag, which allows an object to be deactivated and its transaction to commit or abort, is only evaluated after the object returns from the call that first entered its context. For example, suppose client A calls into object B. Object B calls SetComplete and then calls into object C (passing it a safe reference for a callback). Object C calls back to object B, and then object B returns to client A. Object B won't be deactivated when it returns to object C; it will be deactivated when it returns to client A.

See Also

Basic Security Methods, Passing Object References, Context Objects, Transactions, Deactivating Objects


IObjectContext::CreateInstance Method

Instantiates an MTS object.

Provided By

IObjectContext

HRESULT IObjectContext::CreateInstance (

REFCLSID rclsid,

REFIID riid,

LPVOID FAR* ppvObj

);

Parameter

rclsid
[in] A reference to the CLSID of the type of object to instantiate.

riid
[in] A reference to the interface ID of the interface through which you want to communicate with the new object.

ppvObj
[out] A reference to the requested interface on the new object.

Return Values

S_OK
The object was created and a reference to it is returned in the ppvObj parameter.

REGDB_E_CLASSNOTREG
The component specified by rclsid is not registered as a COM component.

E_OUTOFMEMORY
There's not enough memory available to instantiate the object.

E_INVALIDARG
The argument passed in the ppvObj parameter is invalid.

E_UNEXPECTED
An unexpected error occurred. This can happen if one object passes its IObjectContext pointer to another object, and the other object calls CreateInstance using this pointer. An IObjectContext pointer is not valid outside the context of the object that originally obtained it.

Remarks

CreateInstance creates a COM object. However, the object will have context only if its component is registered with MTS.

When you create an object by using CreateInstance, the new object's context is derived from the current object's ObjectContext and the declarative properties of the new object's component. The new object always executes within the same activity as the object that created it. If the current object has a transaction, the transaction attribute of the new object's component determines whether or not the new object will execute within the scope of that transaction.

If the component's transaction attribute is set to either Requires a transaction or Supports transactions, the new object inherits its creator's transaction. If the component's transaction attribute is set to Requires a new transaction, MTS initiates a new transaction for the new object. If the component's transaction attribute is set to Does not support transactions, the new object doesn't execute under any transaction.

If the Microsoft Distributed Transaction Coordinator is not running and the object is transactional, the object is successfully created. However, method calls to that object will fail with CONTEXT_E_TMNOTAVAILABLE. Objects cannot recover from this condition and should be released.

MTS always uses standard marshaling. Even if a component exposes the IMarshal interface, its IMarshal methods will never be called by the MTS run-time environment.

You can't create MTS objects as part of an aggregation. In this respect, using CreateInstance is like using CoCreateInstance and specifying NULL for the controlling IUnknown interface (pUnkOuter).

Example

See Also

Creating MTS Objects, Transaction Attributes, MTS Component Requirements


IObjectContext::DisableCommit Method

Declares that the object's transactional updates are inconsistent and can't be committed in their present state.

Provided By

IObjectContext

HRESULT IObjectContext::DisableCommit ( );

Return Values

S_OK
The call to DisableCommit succeeded. The object's transactional updates can't be committed until the object calls either EnableCommit or SetComplete.

E_UNEXPECTED
An unexpected error occurred. This can happen if one object passes its IObjectContext pointer to another object and the other object calls DisableCommit using this pointer. An IObjectContext pointer is not valid outside the context of the object that originally obtained it.

CONTEXT_E_NOCONTEXT
The current object doesn't have a context associated with it. This is probably because it wasn't created with one of the MTS CreateInstance methods.

Remarks

An object that invokes DisableCommit is stateful.

You can use the DisableCommit method to prevent a transaction from committing prematurely between method calls in a stateful object. When an object invokes DisableCommit, it indicates that its work is inconsistent and that it can't complete its work until it receives further method invocations from the client. It also indicates that it needs to maintain its state to perform that work. This prevents the MTS run-time environment from deactivating the object and reclaiming its resources on return from a method call. Once an object has called DisableCommit, if a client attempts to commit the transaction before the object has called EnableCommit or SetComplete, the transaction will abort.

For example, suppose you have a General Ledger component that updates a database. A client makes multiple calls to a General Ledger object to post entries to various accounts. There's an integrity constraint that says the debits must equal the credits when the final method invocation returns, or the transaction must abort. The General Ledger object has an initialization method in which the client informs it of the sequence of calls the client is going to make, and the General Ledger object calls DisableCommit. The object maintains its state between calls so that after the final call in the sequence is made the object can make sure the integrity constraint is satisfied before allowing its work to be committed.

Example

See Also

Transactions


IObjectContext::DisableCommit Method Example

#include <mtx.h>

IObjectContext* pObjectContext = NULL;

HRESULT hr;

hr = GetObjectContext(&pObjectContext);

hr = pObjectContext->DisableCommit();


IObjectContext::EnableCommit Method

Declares that the current object's work is not necessarily finished, but that its transactional updates are consistent and could be committed in their present form.

Provided By

IObjectContext

HRESULT IObjectContext::EnableCommit ( );

Return Values

S_OK
The call to EnableCommit succeeded and the object's transactional updates can now be committed.

E_UNEXPECTED
An unexpected error occurred. This can happen if one object passes its IObjectContext pointer to another object and the other object calls EnableCommit using this pointer. An IObjectContext pointer is not valid outside the context of the object that originally obtained it.

Remarks

When an object calls EnableCommit, it allows the transaction in which it's participating to be committed, but it maintains its internal state across calls from its clients until it calls SetComplete or SetAbort or until the transaction completes.

EnableCommit is the default state when an object is activated. This is why an object should always call SetComplete or SetAbort before returning from a method, unless you want the object to maintain its internal state for the next call from a client.

Example

See Also

Transactions


IObjectContext::EnableCommit Method Example

#include <mtx.h>

IObjectContext* pObjectContext = NULL;

HRESULT hr;

hr = GetObjectContext(&pObjectContext);

hr = pObjectContext->EnableCommit();


IObjectContext::IsCallerInRole Method

Indicates whether an object's direct caller is in a specified role (either individually or as part of a group).

Provided By

IObjectContext

HRESULT IObjectContext::IsCallerInRole (

BSTR bstrRole,

BOOL* pfIsInRole

);

Parameters

bstrRole
[in] The name of the role in which you want to determine whether the caller is acting.

pfIsInRole
[out] TRUE if the caller is in the specified role, FALSE if not. This parameter will also be set to TRUE if security is not enabled.

Return Values

S_OK
The role specified in the bstrRole parameter is a recognized role, and the Boolean result returned in the pfIsInRole parameter indicates whether or not the caller is in that role.

CONTEXT_E_
ROLENOTFOUND
The role specified in the bstrRole parameter does not exist.

E_INVALIDARG
One or more of the arguments passed in is invalid.

E_UNEXPECTED
An unexpected error occurred. This can happen if one object passes its IObjectContext pointer to another object and the other object calls IsCallerInRole using this pointer. An IObjectContext pointer is not valid outside the context of the object that originally obtained it.

Remarks

You use this method to determine whether the direct caller of the currently executing method is associated with a specific role. A role is a symbolic name that represents a user or group of users who have specific access permissions to all components in a given package. Developers define roles when they create a component, and roles are mapped to individual users or groups at deployment time.

IsCallerInRole only applies to the direct caller of the currently executing method. (The direct caller is the process calling into the current server process. It can be either a base client process or a server process.) IsCallerInRole doesn't apply to the process that initiated the call sequence from which the current method was called, or to any other callers in that sequence.

Because IsCallerInRole returns TRUE when the object that invokes it is executing in a client's process, it's a good idea to call IsSecurityEnabled before calling IsCallerInRole. If security isn't enabled, IsCallerInRole won't return an accurate result.

Example

See Also

Programmatic Security, Basic Security Methods, Secured Components


IObjectContext::IsCallerInRole, IObjectContext::IsSecurityEnabled Methods Example

#include <mtx.h>

IObjectContext* pObjectContext = NULL;

BSTR stRole = SysAllocString(L"Manager");

VARIANT_BOOL fIsInRole;

HRESULT hr;

hr = GetObjectContext(&pObjectContext);

// Find out if security is enabled.

if (pObjectContext->IsSecurityEnabled()) {

//Then find out if the caller is in the right role.

fIsInRole = pObjectContext->IsCallerInRole

(stRole, &fIsInRole)

SysFreeString(stRole);

if (!fIsInRole) {

// If not, do something appropriate here.

}

}

else {

// If security's not enabled, do something

// appropriate here.

}


IObjectContext::IsInTransaction Method

Indicates whether the current object is executing in a transaction.

Provided By

IObjectContext

BOOL IObjectContext::IsInTransaction ( );

Return Values

TRUE
The current object is executing within a transaction.

FALSE
The current object is not executing within a transaction.

Remarks

You can use this method to make sure that an object that requires a transaction never runs without one. For example, if a component that requires a transaction is improperly configured in the MTS Explorer, you can use this method to determine that the object doesn't have a transaction. Then you can return an error to alert the user to the problem, or take whatever action is appropriate.

Example

See Also

Transaction Attributes, Transactions


IObjectContext::IsInTransaction Method Example

#include <mtx.h>

IObjectContext* pObjectContext = NULL;

VARIANT_BOOL fInTransaction;

HRESULT hr;

hr = GetObjectContext(&pObjectContext);

// Find out if the object is in a transaction.

fInTransaction = pObjectContext->IsInTransaction();

if (!fInTransaction) {

// If not, do something appropriate here.

}


IObjectContext::IsSecurityEnabled Method

Indicates whether or not security is enabled for the current object. MTS security is enabled unless the object is running in the client's process.

Provided By

IObjectContext

BOOL IObjectContext::IsSecurityEnabled ( );

Return Values

TRUE
Security is enabled for this object.

FALSE
Security is not enabled for this object.

Remarks

MTS security is enabled only if an object is running in a server process. This could be either because the object's component was configured to run in a client's process, or because the component and the client are in the same package. If the object is running in the client's process, there is no security checking and IsSecurityEnabled will always return FALSE.

Example

See Also

Programmatic Security, Basic Security Methods, Secured Components


IObjectContext::SetAbort Method

Declares that the transaction in which the object is executing must be aborted, and that the object should be deactivated on returning from the currently executing method call.

Provided By

IObjectContext

HRESULT IObjectContext::SetAbort ( );

Return Values

S_OK
The call to SetAbort succeeded and the transaction will be aborted.

E_UNEXPECTED
An unexpected error occurred. This can happen if one object passes its IObjectContext pointer to another object and the other object calls SetAbort using this pointer. An IObjectContext pointer is not valid outside the context of the object that originally obtained it.

Remarks

The object is deactivated automatically on return from the method in which it called SetAbort. If the object is the root of an automatic transaction, MTS aborts the transaction. If the object is transactional, but not the root of an automatic transaction, the transaction in which it's participating is doomed to abort. (An object is the root of a transaction if the MTS run-time environment has to initiate a new transaction for it. This is the case when the component that provides the object is configured to require a transaction and the object's creator doesn't have one, or when the component is configured to require a new transaction.)

You can call SetAbort in error handlers to ensure that a transaction aborts when an error occurs. You can also call SetAbort at the beginning of a method to protect your object from committing prematurely in the event of an unexpected return and then call SetComplete just before the method returns, if all goes well.

Example

See Also

Transactions, Context Objects, Deactivating Objects


IObjectContext::SetAbort, IObjectContext::SetComplete Methods Example

#include <mtx.h>

IObjectContext* pObjectContext = NULL;

HRESULT hr;

hr = GetObjectContext(&pObjectContext);

// Do some work here.

// If the work was successful, call SetComplete.

if (SUCCEEDED(hr)) {

if (pObjectContext)

pObjectContext->SetComplete();

}

// Otherwise, call SetAbort.

else {

if (pObjectContext)

pObjectContext->SetAbort();

}


IObjectContext::SetComplete Method

Declares that the current object has completed its work and should be deactivated when the currently executing method returns to the client. For objects that are executing within the scope of a transaction, it also indicates that the object's transactional updates can be committed.

Provided By

IObjectContext

HRESULT IObjectContext::SetComplete ( );

Return Values

S_OK
The call to SetComplete succeeded.

E_UNEXPECTED
An unexpected error occurred. This can happen if one object passes its IObjectContext pointer to another object and the other object calls SetComplete using this pointer. An IObjectContext pointer is not valid outside the context of the object that originally obtained it.

Remarks

The object is deactivated automatically on return from the method in which it called SetComplete. If the object is the root of an automatic transaction, MTS attempts to commit the transaction. However, if any object that was participating in the transaction has called SetAbort, or has called DisableCommit and has not subsequently called EnableCommit or SetComplete, the transaction will be aborted. (An object is the root of a transaction if the MTS run-time environment has to initiate a new transaction for it. This is the case when the component that provides the object is configured to require a transaction and the object's creator doesn't have one, or when the component is configured to require a new transaction.)

If an object doesn't need to maintain its state after it returns from a method call, it should call SetComplete so that it can be automatically deactivated as soon as it returns and its resources can be reclaimed.

Example

See Also

Transactions, Context Objects, Deactivating Objects


MTx.SafeRef Method

Used by an object to obtain a reference to itself that's safe to pass outside its context.

SafeRef is a static method of the MTx class, which is declared in the package com.ms.mtx.

Note  The class MTx has only static methods and has no public constructor. You can't create an instance of this class.

IUnknown SafeRef (

IUnknown obj

);

Parameter

obj
[in] A reference to an interface on the current object.

Return Value

A reference to the IUnknown interface on the current object that's safe to pass outside the current object's context.

Remarks

When an MTS object wants to pass a self-reference to a client or another object (for example, for use as a callback), it should always call SafeRef first and then pass the reference returned by this call. An object should never pass a reference to this to a client or to any other object. Once such a reference is passed outside the object's context, it's no longer a valid reference.

Regardless of the interface ID you pass to SafeRef, it always returns the IUnknown interface on the object that calls it. You should immediately cast the returned value to the interface that you want to pass outside the object.

Calling SafeRef on a reference that is already safe returns the safe reference unchanged, except that the reference count on the interface is incremented.

Example

See Also

Passing Object References


MTx.SafeRef Method Example

import com.ms.mtx.*;

IMyInterface safeMyObject = null;

IAnotherObject someOtherObject = null;

// Get a safe reference.

safeMyObject = (IMyInterface) MTx.SafeRef(this);

// Invoke a method on another object, passing the

// safe reference so it can call back.

someOtherObject.CallMeBack(safeMyObject);


MTx.GetObjectContext Method

Obtains a reference to the IObjectContext interface on the ObjectContext that's associated with the current MTS object.

GetObjectContext is a static method of the MTx class, which is declared in the package com.ms.mtx.

Note   The MTx class has only static methods and has no public constructor. You can't create an instance of this class.

IObjectContext GetObjectContext ( );

Return Value

A reference to the IObjectContext interface on the current object's context. GetObjectContext will return null if it is called from a constructor or finalizer, or if the object's component hasn't been imported into an MTS package.

Remarks

An object should never attempt to pass its ObjectContext reference to another object. If you pass an ObjectContext reference to another object, it will no longer be a valid reference.

Example

See Also

Building Scalable Components, Context Objects, IObjectContext.CreateInstance Method


MTx.GetObjectContext Method, IObjectContext.CreateInstance Method Example

import com.ms.mtx.*;

IAccount account = null;

// Get the object's ObjectContext and

// use it to instantiate another object.

account = (IAccount) MTx.GetObjectContext().

CreateInstance(CAccount.clsid, IAccount.iid);


IObjectContext Interface

The IObjectContext interface provides access to the current object's context.

Remarks

The IObjectContext interface is declared in the package com.ms.mtx.

You obtain a reference to the IObjectContext interface by calling the MTx.GetObjectContext method. As with any COM object, you must release an ObjectContext object when you're finished using it, unless it's a local variable.

You can use an object's ObjectContext to:

•	Declare that the object's work is complete.

•	Prevent a transaction from being committed, either temporarily or permanently.

•	Instantiate other MTS objects and include their work within the scope of the current object's transaction.

•	Find out if a caller is in a particular role.

•	Find out if security is enabled.

•	Find out if the object is executing within a transaction.

The IObjectContext interface exposes the following methods.

Method	Description
CreateInstance	Instantiates another MTS object.
DisableCommit	Declares that the object hasn't finished its work and that its transactional updates are in an inconsistent state. The object retains its state across method calls, and any attempts to commit the transaction before the object calls EnableCommit or SetComplete will result in the transaction being aborted.
EnableCommit	Declares that the object's work isn't necessarily finished, but its transactional updates are in a consistent state. This method allows the transaction to be committed, but the object retains its state across method calls until it calls SetComplete or SetAbort, or until the transaction is completed.
IsCallerInRole	Indicates whether the object's direct caller is in a specified role (either directly or as part of a group).
IsInTransaction	Indicates whether the object is executing within a transaction.
IsSecurityEnabled	Indicates whether security is enabled. MTS security is enabled unless the object is running in the client's process.
SetAbort	Declares that the object has completed its work and can be deactivated on returning from the currently executing method, but that its transactional updates are in an inconsistent state or that an unrecoverable error occurred. This means that the transaction in which the object was executing must be aborted. If any object executing within a transaction returns to its client after calling SetAbort, the entire transaction is doomed to abort.
SetComplete	Declares that the object has completed its work and can be deactivated on returning from the currently executing method. For objects that are executing within the scope of a transaction, it also indicates that the object's transactional updates can be committed. When an object that is the root of a transaction calls SetComplete, MTS attempts to commit the transaction on return from the current method.
Note   When an object calls DisableCommit, EnableCommit, SetComplete, or SetAbort from within a method, two flags (Done and Consistent) are set in its ObjectContext. (See the following table for an explanation.) These flags aren't evaluated by the MTS run-time environment until the object's currently executing method returns to its caller. This means that an object can call these methods any number of times from within one of its own methods, but the last call before the object returns to its client is the one that will be in effect.

Method	Done	Consistent
SetAbort	TRUE	FALSE
SetComplete	TRUE	TRUE
DisableCommit	FALSE	FALSE
EnableCommit	FALSE	TRUE
The Done flag, which allows an object to be deactivated and its transaction to commit or abort, is only evaluated after the object returns from the call that first entered its context. For example, suppose client A calls into object B. Object B calls SetComplete and then calls into object C (passing it a safe reference for a callback). Object C calls back to object B, and then object B returns to client A. Object B won't be deactivated when it returns to object C; it will be deactivated when it returns to client A.

See Also

Basic Security Methods, Passing Object References, Context Objects, Transactions, Deactivating Objects


IObjectContext.CreateInstance Method

Instantiates an MTS object.

Provided By

IObjectContext Interface

IUnknown CreateInstance (

_Guid clsid,

_Guid iid,

);

Parameter

clsid
[in] The clsid of the type of object to instantiate.

iid
[in] Any interface that's implemented by the object you want to instantiate.

Return Value

A reference to the IUnknown interface on the newly created object.

Remarks

CreateInstance creates a COM object. However, the object will have context only if its component is registered with MTS.

When you create an object by using CreateInstance, the new object's context is derived from the current object's ObjectContext and the declarative properties of the new object's component. The new object always executes within the same activity as the object that created it. If the current object has a transaction, the transaction attribute of the new object's component determines whether or not the new object will execute within the scope of that transaction.

If the component's transaction attribute is set to either Requires a transaction or Supports transactions, the new object inherits its creator's transaction. If the component's transaction attribute is set to Requires a new transaction, MTS initiates a new transaction for the new object. If the component's transaction attribute is set to Does not support transactions, the new object doesn't execute under any transaction.

CreateInstance always returns the IUnknown interface on the newly instantiated object. You should immediately cast the returned value to the interface through which you want to communicate with the new object. The interface ID you pass in the iid parameter doesn't have to be the same interface as the one to which you cast the returned value, but it must be an interface that's implemented by the object you're instantiating.

MTS always uses standard marshaling. Even if a component exposes the IMarshal interface, its IMarshal methods will never be called by the MTS run-time environment.

You can't create MTS objects as part of an aggregation.

Example

See Also

Creating MTS Objects, Transaction Attributes, MTS Component Requirements


IObjectContext.DisableCommit Method

Declares that the object's transactional updates are inconsistent and can't be committed in their present state.

Provided By

IObjectContext

void DisableCommit ( );

Remarks

An object that invokes DisableCommit is stateful.

You can use the DisableCommit method to prevent a transaction from committing prematurely between method calls in a stateful object. When an object invokes DisableCommit, it indicates that its work is inconsistent and that it can't complete its work until it receives further method invocations from the client. It also indicates that it needs to maintain its state to perform that work. This prevents the MTS run-time environment from deactivating the object and reclaiming its resources on return from a method call. Once an object has called DisableCommit, if a client attempts to commit the transaction before the object has called EnableCommit or SetComplete, the transaction will abort.

For example, suppose you have a General Ledger component that updates a database. A client makes multiple calls to a General Ledger object to post entries to various accounts. There's an integrity constraint that says the debits must equal the credits when the final method invocation returns, or the transaction must abort. The General Ledger object has an initialization method in which the client informs it of the sequence of calls the client is going to make, and the General Ledger object calls DisableCommit. The object maintains its state between calls so that after the final call in the sequence is made the object can make sure the integrity constraint is satisfied before allowing its work to be committed.

Example

See Also

Transactions


IObjectContext.DisableCommit Method Example

import com.ms.mtx.*;

MTx.GetObjectContext().DisableCommit();


IObjectContext.EnableCommit Method

Declares that the current object's work is not necessarily finished, but that its transactional updates are consistent and could be committed in their present form.

Provided By

IObjectContext

void EnableCommit ( );

Remarks

When an object calls EnableCommit, it allows the transaction in which it's participating to be committed, but it maintains its internal state across calls from its clients until it calls SetComplete or SetAbort or until the transaction completes.

EnableCommit is the default state when an object is activated. This is why an object should always call SetComplete or SetAbort before returning from a method, unless you want the object to maintain its internal state for the next call from a client.

Example

See Also

Transactions


IObjectContext.EnableCommit Method Example

import com.ms.mtx.*;

MTx.GetObjectContext().EnableCommit();


IObjectContext.IsCallerInRole Method

Indicates whether an object's direct caller is in a specified role (either individually or as part of a group).

Provided By

IObjectContext

boolean IsCallerInRole (

String bstrRole

);

Parameters

bstrRole
[in] The name of the role in which you want to determine whether the caller is acting.

Return Values

true
Either the caller is in the specified role, or security is not enabled.

false
The caller is not in the specified role.

Remarks

You use this method to determine whether the direct caller of the currently executing method is associated with a specific role. A role is a symbolic name that represents a user or group of users who have specific access permissions to all components in a given package. Developers define roles when they create a component, and roles are mapped to individual users or groups at deployment time.

IsCallerInRole only applies to the direct caller of the currently executing method. (The direct caller is the process calling into the current server process. It can be either a base client process or a server process.) IsCallerInRole doesn't apply to the process that initiated the call sequence from which the current method was called, or to any other callers in that sequence.

Because IsCallerInRole returns true when the object that invokes it is executing in a client's process, it's a good idea to call IsSecurityEnabled before calling IsCallerInRole. If security isn't enabled, IsCallerInRole won't return an accurate result.

Example

See Also

Programmatic Security, Basic Security Methods, Secured Components


IObjectContext.IsCallerInRole, IObjectContext.IsSecurityEnabled Methods Example

import com.ms.mtx.*;

IObjectContext objContext = null;

objContext = MTx.GetObjectContext();

// Find out if Security is enabled.

if (objContext.IsSecurityEnabled()) {

//Then find out if the caller is in the right role.

if (!objContext.IsCallerInRole("Manager")) {

// If not, do something appropriate here.

}

}

else {

// If security's not enabled, do something

// appropriate here.

}


IObjectContext.IsInTransaction Method

Indicates whether the current object is executing in a transaction.

Provided By

IObjectContext

boolean IsInTransaction ( );

Return Values

true
The current object is executing within a transaction.

false
The current object is not executing within a transaction.

Remarks

You can use this method to make sure that an object that requires a transaction never runs without one. For example, if a component that requires a transaction is improperly configured in the MTS Explorer, you can use this method to determine that the object doesn't have a transaction. Then you can return an error to alert the user to the problem, or take whatever action is appropriate.

Example

See Also

Transaction Attributes, Transactions


IObjectContext.IsInTransaction Method Example

import com.ms.mtx.*;

// Find out if the object is in a transaction.

if (!MTx.GetObjectContext().IsInTransaction()) {

// If not, do something appropriate here.

}


IObjectContext.IsSecurityEnabled Method

Indicates whether or not security is enabled for the current object. MTS security is enabled unless the object is running in the client's process.

Provided By

IObjectContext

boolean IsSecurityEnabled ( );

Return Values

true
Security is enabled for this object.

false
Security is not enabled for this object.

Remarks

MTS security is enabled only if an object is running in a server process. This could be either because the object's component was configured to run in a client's process, or because the component and the client are in the same package. If the object is running in the client's process, there is no security checking and IsSecurityEnabled will always return false.

Example

See Also

Programmatic Security, Basic Security Methods, Secured Components


IObjectContext.SetAbort Method

Declares that the transaction in which the object is executing must be aborted, and that the object should be deactivated on returning from the currently executing method call.

Provided By

IObjectContext

void SetAbort ( );

Remarks

The object is deactivated automatically on return from the method in which it called SetAbort. If the object is the root of an automatic transaction, MTS aborts the transaction. If the object is transactional, but not the root of an automatic transaction, the transaction in which it's participating is doomed to abort. (An object is the root of a transaction if the MTS run-time environment has to initiate a new transaction for it. This is the case when the component that provides the object is configured to require a transaction and the object's creator doesn't have one, or when the component is configured to require a new transaction.)

You can call SetAbort in error handlers to ensure that a transaction aborts when an error occurs. You can also call SetAbort at the beginning of a method to protect your object from committing prematurely in the event of an unexpected return and then call SetComplete just before the method returns, if all goes well.

Example

See Also

Transactions, Context Objects, Deactivating Objects


IObjectContext.SetAbort, IObjectContext.SetComplete Methods Example

import com.ms.mtx.*;

boolean success = false;

// Do some work here.

// If the work was successful, call SetComplete

if (success)

MTx.GetObjectContext().SetComplete();

// Otherwise, call SetAbort.

else

MTx.GetObjectContext().SetAbort();


IObjectContext.SetComplete Method

Declares that the current object has completed its work and should be deactivated when the currently executing method returns to the client. For objects that are executing within the scope of a transaction, it also indicates that the object's transactional updates can be committed.

Provided By

IObjectContext

void SetComplete ( );

Remarks

The object is deactivated automatically on return from the method in which it called SetComplete. If the object is the root of an automatic transaction, MTS attempts to commit the transaction. However, if any object that was participating in the transaction has called SetAbort, or has called DisableCommit and has not subsequently called EnableCommit or SetComplete, the transaction will be aborted. (An object is the root of a transaction if the MTS run-time environment has to initiate a new transaction for it. This is the case when the component that provides the object is configured to require a transaction and the object's creator doesn't have one, or when the component is configured to require a new transaction.)

If an object doesn't need to maintain its state after it returns from a method call, it should call SetComplete so that it can be automatically deactivated as soon as it returns and its resources can be reclaimed.

Example

See Also

Transactions, Context Objects, Deactivating Objects


IObjectContextActivity Interface

The IObjectContextActivity interface is used to retrieve a unique identifier associated with the current activity. This activity identifier is a GUID, and is only valid for the lifetime of the current activity.

Remarks

The header file for the IObjectContextActivity is mtx.h. You must also link mtxguid.lib to your project to use this interface.

You obtain a reference to an object's IObjectContextActivity interface by calling QueryInterface on the object's ObjectContext. For example:

m_pIObjectContext->QueryInterface

    (IID_IObjectContextActivity,

    (void**)&m_pIObjectContextActivity));

The IObjectContextActivity interface provides the following methods.

Method	Description
GetActivityId	Retrieves the GUID associated with the current activity.


IObjectContextActivity::GetActivityId Method

Retrieves the GUID associated with the current activity.

Provided By

IObjectContextActivity

HRESULT IObjectContextActivity::GetActivityId(
GUID * pActivityId);

Parameters

pActivityId
[out] A reference to the GUID associated with the current activity.

Return Values

S_OK
The GUID of the current activity is returned in the parameter pActivityId.

E_INVALIDARG
The argument passed in the pActivityId parameter is a NULL pointer.

E_UNEXPECTED
An unexpected error occurred.

Example


GetActivityId Method Example

#include <mtx.h>

HRESULT hr = S_OK;

IObjectContext *pIObjectContext = NULL;

IObjectContextActivity *pIObjectContextActivity = NULL;

GUID activityId;

// Get object context

hr = GetObjectContext(&pIObjectContext);

// Get IObjectContextActivity interface

hr = pIObjectContext->

    QueryInterface(IID_IObjectContextActivity,

    (void**)&pIObjectContextActivity);

// Use IObjectContextActivity to retrieve

// the activity GUID.

hr = pIObjectContextActivity->

    GetActivityId(&activityId);

// Do something with the activity GUID here.

// Release the IObjectContextActivity

// and the IObjectContext pointers

pIObjectContextActivity->Release();

pIObjectContext->Release();


SharedPropertyGroupManager Object

The SharedPropertyGroupManager object is used to create shared property groups and to obtain access to existing shared property groups.

Remarks

To use the SharedPropertyGroupManager object, you must set a reference to the Shared Property Manager Type Library (mtxspm.dll).

You can access the SharedPropertyGroupManager object by using either the CreateObject function or the CreateInstance method of the ObjectContext object. It makes no difference which you use.

The Shared Property Manager is a resource dispenser that you can use to share state among multiple objects within a server process. You can't use global variables in a distributed environment because of concurrency and name collision issues. The Shared Property Manager eliminates name collisions by providing shared property groups, which establish unique name spaces for the shared properties they contain. The Shared Property Manager also implements locks and semaphores to protect shared properties from simultaneous access, which could result in lost updates and could leave the properties in an unpredictable state.

Shared properties can be shared only by objects running in the same process. If you want instances of different components to share properties, you have to install the components in the same MTS package. Because there is a risk that administrators will move components from one package to another, it's safest to limit the use of a shared property group to instances of components that are defined in the same DLL.

It's also important for components sharing properties to have the same activation attribute. If two components in the same package have different activation attributes, they generally won't be able to share properties. For example, if one component is configured to run in a client's process and the other is configured to run in a server process, their objects will usually run in different processes, even though they're in the same package.

You should always instantiate the SharedPropertyGroupManager, SharedPropertyGroup, and SharedProperty objects from MTS objects rather than from a base client. If a base client creates shared property groups and properties, the shared properties are inside the base client's process, not in a server process. This means MTS objects can't share the properties unless the objects, too, are running in the client's process (which is generally not a good idea).

Note   When you set the isolation mode to LockMethod, the Shared Property Manager requires access to the calling object's ObjectContext. You can't use this isolation mode to create a shared property group from within an object's constructor or from a non-MTS object because ObjectContext isn't available during object construction and a non-MTS object doesn't have an ObjectContext.

The SharedPropertyGroupManager object provides the following methods and properties.

Method	Description
CreatePropertyGroup	Creates a new SharedPropertyGroup with a string name as an identifier. If a group with the specified name already exists, CreatePropertyGroup returns a reference to the existing group.
Group	Returns a reference to an existing shared property group, given a string name by which it can be identified.
See Also

Sharing State


CreatePropertyGroup Method

Creates and returns a reference to a new shared property group. If a property group with the specified name already exists, CreatePropertyGroup returns a reference to the existing group.

Applies To

SharedPropertyGroupManager Object

Syntax

Set propertygroup = sharedpropertygroupmanager.CreatePropertyGroup(name, dwIsoMode, dwrelmode, fExists)

Parameters

propertygroup
An object variable that evaluates to a SharedPropertyGroup object.

sharedpropertygroupmanager
An object variable that represents the SharedPropertyGroupManager with which to create the shared property group.

name
A string expression that contains the name of the shared property group to create.

dwIsoMode
A Long value that specifies the isolation mode for the properties in the new shared property group. See the table that lists dwIsoMode constants later in this topic. If the value of the fExists parameter is set to True on return from this method, the dwIsoMode value you passed in is ignored and the value returned in this parameter is the isolation mode that was assigned when the property group was created.

dwRelMode
A Long value that specifies the release mode for the properties in the new shared property group. See the table that lists dwRelMode constants later in this topic. If the value of the fExists parameter is set to True on return from this method, the dwRelMode value you passed in is ignored and the value returned in this parameter is the release mode that was assigned when the property group was created.

fExists
A Boolean value that's set to True on return from this method if the shared property group specified in the name parameter existed prior to this call, and False if the property group was created by this call.

Settings

The following constants are used in the dwIsoMode parameter to specify the effective isolation mode for a shared property group.

Constant	Value	Description
LockSetGet	0	Default. Locks a property during a Value call, assuring that every get or set operation on a shared property is atomic. This ensures that two clients can't read or write to the same property at the same time, but it doesn't prevent other clients from concurrently accessing other properties in the same group.
LockMethod	1	Locks all of the properties in the shared property group for exclusive use by the caller as long as the caller's current method is executing. This is the appropriate mode to use when there are interdependencies among properties, or in cases where a client may have to update a property immediately after reading it before it can be accessed again.
Note   When you set the isolation mode to LockMethod, the Shared Property Manager requires access to the calling object's ObjectContext. You can't use this isolation mode to create a shared property group from within an object's constructor or from a non-MTS object because ObjectContext isn't available during object construction and a base client doesn't have an ObjectContext.

The following constants are used in the dwRelMode parameter to specify the effective release mode for a shared property group.

Constant	Value	Description
Standard	0	When all clients have released their references on the property group, the property group is automatically destroyed.
Process	1	The property group isn't destroyed until the process in which it was created has terminated. You must still release all SharedPropertyGroup objects by setting them to Nothing.
Remarks

The CreatePropertyGroup method sets the value in fExists to True if the property group it returns existed prior to the current call. This occurs when another object in the same process has already called CreatePropertyGroup with the same property group name. The CreatePropertyGroup method sets the value in fExists to False if the returned property group was created by the current call.

The isolation mode and release mode are assigned when the property group is originally created and aren't changed if a subsequent call passes different values in these parameters. The caller should always check the value of fExists on return from this method. If fExists is set to True, the caller should check the values returned in dwIsoMode and dwRelMode to determine the isolation and release modes in effect for the property group. For example:

Dim isolationMode As Long

Dim releaseMode As Long

Set isolationMode = LockMethod

Set releaseMode = Process

Set spmGroup = spmMgr.CreatePropertyGroup _

("Counter", isolationMode, releaseMode, fExists)

If fExists Then

If isolationMode <> LockMethod _

Or releaseMode <> Process Then

' Do something appropriate.

EndIf

EndIf

You can pass the constants, LockGetSet or LockMethod as the dwIsoMode argument, and Standard or Process as the dwRelMode argument, directly to the CreatePropertyGroup method. However, when you pass a constant instead of a variable, the CreatePropertyGroup method can't return the isolation and release modes currently in effect if the requested property group already exists.

Note   An object should never attempt to pass a shared property group reference to another object. If the reference is passed outside of the object that acquired it, it's no longer a valid reference.

Example

See Also

Sharing State, IObjectContext Interface, SharedPropertyGroup Object


Group Property

Returns a reference to an existing shared property group.

Applies To

ISharedPropertyGroupManager Interface

Syntax

Set propertygroup = sharedpropertygroupmanager.Group(name)

Parameters

propertygroup
An object variable that evaluates to a SharedPropertyGroup object.

sharedpropertygroupmanager
An object variable that represents the SharedPropertyGroupManager for the current process.

name
A string expression that contains the name of the shared property group to retrieve.

Example

See Also

Sharing State, SharedPropertyGroupManager Object


SharedPropertyGroup Object

The SharedPropertyGroup object is used to create and access the shared properties in a shared property group.

Remarks

To use the SharedPropertyGroup object, you must set a reference to the Shared Property Manager Type Library (mtxspm.dll)

You can create a SharedPropertyGroup object with the CreatePropertyGroup method of the SharedPropertyGroupManager object.

As with any COM object, you must release a SharedPropertyGroup object when you're finished using it, unless it's a local variable. For example:

Set myPropertyGroup = Nothing

The SharedPropertyGroup object provides the following methods and properties.

Method/Property	Description
CreateProperty	Creates a new shared property identified by a string expression that's unique within its property group.
CreatePropertyByPosition	Creates a new shared property identified by a numeric index within its property group.
Property	Returns a reference to a shared property, given the string name by which the property is identified.
PropertyByPosition	Returns a reference to a shared property, given its numeric index in the shared property group.
See Also

Sharing State, ISharedPropertyGroupManager Object


CreateProperty Method

Creates and returns a reference to a new SharedProperty with a specified name. If a shared property by that name already exists, CreateProperty returns a reference to the existing property.

Applies To

SharedPropertyGroup Object

Syntax

Set property = propertygroup.CreateProperty(name, fExists)

Parameters

propertygroup
An object variable that represents the SharedPropertyGroup to which the new SharedProperty object will belong.

property
An object variable that evaluates to a SharedProperty object.

name
A string expression that contains the name of the property to create. You can use this name later to obtain a reference to this property.

fExists
A Boolean value that's set to True on return from this method if the shared property specified in the name parameter existed prior to this call, and False if the property was created by this call.

Remarks

When you create a shared property, its value is set to the default, which is 0.

If you create a shared property with the CreateProperty method, you can access that property only by using Property. You can't assign a numeric index to the same property and then access it by using PropertyByPosition.

The same shared property group can contain some shared property objects that are identified by name and others that are identified by position.

Example

See Also

Sharing State, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_PropertyByPosition Method, ISharedPropertyGroup::get_Property Method


CreatePropertyByPosition Method

Creates a new shared property identified by a numeric index that's unique within the property group. If a shared property with the specified index already exists, CreatePropertyByPosition returns a reference to the existing one.

Applies To

SharedPropertyGroup Object

Syntax

Set property = propertygroup.CreatePropertyByPosition (index, fExists)

Parameters

property
An object variable that evaluates to a SharedProperty object.

propertygroup
An object variable that represents the SharedPropertyGroup to which the new SharedProperty object will belong.

index
A Long value that represents the numeric index within the SharedPropertyGroup by which the new property will be referenced. You can use this index later to retrieve the shared property with PropertyByPosition.

fExists
A Boolean value. If fExists is set to True on return from this method, the shared property specified by index existed prior to this call. If it's set to False, the property was created by this call.

Remarks

When you create a shared property, its value is set to the default, which is 0.

If you create a SharedProperty object with the CreatePropertyByPosition method, you can access that property only by using PropertyByPosition. You can't assign a string name to the same property and then access it by using Property. Accessing a property by position is faster than accessing a property by using a string name because it requires less overhead.

The same shared property group can contain some SharedProperty objects that are identified by position and others that are identified by name.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::get_PropertyByPosition Method, ISharedPropertyGroup::get_Property Method


CreatePropertyByPosition Method Example

Dim spmMgr As SharedPropertyGroupManager

Dim spmGroup As SharedPropertyGroup

Dim spmPropNextNumber As SharedProperty

Dim bExists As Boolean

Dim iNextValue As Integer

' Create the SharedPropertyGroupManager,

' SharedPropertyGroup, and SharedProperty.

Set spmMgr = CreateObject _

("MTxSpm.SharedPropertyGroupManager.1")

Set spmGroup = spmMgr.CreatePropertyGroup _

("Counter", LockSetGet, Process, bExists)

Set spmPropNextNumber = _

spmGroup.CreatePropertyByPosition(0, bExists)

' Get the next number and increment it.

iNextValue = spmPropNextNumber.Value

spmPropNextNumber.Value = _

spmPropNextNumber.Value + 1


Property Property

Returns a reference to an existing shared property identified by a string name.

Applies To

SharedPropertyGroup Object

Syntax

Set property = propertygroup.Property(name)

Parameters

propertygroup
An object variable that represents the SharedPropertyGroup to which the SharedProperty object belongs.

property
An object variable that evaluates to a SharedProperty object.

name
A string expression that contains the name of the shared property to retrieve.

Remarks

You can use only Property to access properties that were created with the CreateProperty method. To access properties that were created with the CreatePropertyByPosition method, use PropertyByPosition.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_PropertyByPosition Method


Property, Group Properties Example

Dim spmMgr As SharedPropertyGroupManager

Dim spmGroup As SharedPropertyGroup

Dim spmPropNextNumber As SharedProperty

Dim iNextValue As Integer

' Get the SharedPropertyGroupManager,

' SharedPropertyGroup, and SharedProperty.

Set spmMgr = CreateObject _

("MTxSpm.SharedPropertyGroupManager.1")

Set spmGroup = spmMgr.Group("Counter")

Set spmPropNextNumber = spmGroup.Property("Next")

' Get the next number and increment it.

iNextValue = spmPropNextNumber.Value

spmPropNextNumber.Value = _

spmPropNextNumber.Value + 1


PropertyByPosition Property

Returns a reference to an existing shared property identified by its numeric index within the property group.

Applies To

SharedPropertyGroup Object

Syntax

Set sharedproperty = propertygroup.PropertyByPosition(index)

Parameters

propertygroup
An object variable that represents the SharedPropertyGroup object to which the SharedProperty object belongs.

sharedproperty
An object variable that evaluates to a SharedProperty object.

index
A Long value that represents the numeric index within the SharedPropertyGroup of the property to retrieve.

Remarks

You can use only PropertyByPosition to access properties that were created with the CreatePropertyByPosition method. To access properties that were created with the CreateProperty method, use Property.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_Property Method


PropertyByPosition Property Example

Dim spmMgr As SharedPropertyGroupManager

Dim spmGroup As SharedPropertyGroup

Dim spmPropNextNumber As SharedProperty

Dim iNextValue As Integer

' Get the SharedPropertyGroupManager,

' SharedPropertyGroup, and SharedProperty.

Set spmMgr = CreateObject _

("MTxSpm.SharedPropertyGroupManager.1")

Set spmGroup = spmMgr.Group("Counter")

Set spmPropNextNumber = spmGroup.PropertyByPosition(0)

' Get the next number and increment it.

iNextValue = spmPropNextNumber.Value

spmPropNextNumber.Value = _

spmPropNextNumber.Value + 1


SharedProperty Object

The SharedProperty object is used to set or retrieve the value of a shared property. A shared property can contain any data type that can be represented by a variant.

Remarks

To use the SharedProperty object, you must set a reference to the Shared Property Manager Type Library (mtxspm.dll).

You can create a SharedProperty object with the CreateProperty method or the CreatePropertyByPosition method.

A SharedProperty object can be created or accessed only from within a SharedPropertyGroup.

As with any COM object, you must release a SharedProperty object when you're finished using it, unless it's a local variable. For example:

Set myProperty = Nothing

The SharedProperty object provides the following property.

Property	Description
Value	Sets or retrieves the value of a shared property.
See Also

Sharing State, MTS Supported Variant Types


Value Property

Sets or retrieves the value of a shared property.

Applies To

SharedProperty Object

Syntax

property.Value = value

Parameters

property
An object variable that represents a SharedProperty object.

value
A Variant containing the value to assign to the SharedProperty object, or the SharedProperty's current value.

Example

See Also

MTS Supported Variant Types, Sharing State


CreatePropertyGroup Method, CreateProperty Method, Value Property Example

Dim spmMgr As SharedPropertyGroupManager

Dim spmGroup As SharedPropertyGroup

Dim spmPropNextNumber As SharedProperty

Dim bExists As Boolean

Dim iNextValue As Integer

' Create the SharedPropertyGroupManager,

' SharedPropertyGroup, and SharedProperty.

Set spmMgr = CreateObject _

("MTxSpm.SharedPropertyGroupManager.1")

Set spmGroup = spmMgr.CreatePropertyGroup _

("Counter", LockSetGet, Process, bExists)

Set spmPropNextNumber = _

spmGroup.CreateProperty("Next", bExists)

' Get the next number and increment it.

iNextValue = spmPropNextNumber.Value

spmPropNextNumber.Value = _

spmPropNextNumber.Value + 1


ISharedPropertyGroupManager Interface

The ISharedPropertyGroupManager interface is used to create shared property groups and to obtain access to existing shared property groups.

Remarks

The header file for the ISharedPropertyGroupManager interface is mtxspm.h. You must also link mtxguid.lib to your project to use this interface.

You can access the ISharedPropertyGroupManager interface by creating an instance of the SharedPropertyGroupManager by using either IObjectContext::CreateInstance or CoCreateInstance. It makes no difference which you use.

CreateInstance method of the ObjectContext object. It makes no difference which you use.

The Shared Property Manager is a resource dispenser that you can use to share state among multiple objects within a server process. You can't use global variables in a distributed environment because of concurrency and name collision issues. The Shared Property Manager eliminates name collisions by providing shared property groups, which establish unique name spaces for the shared properties they contain. The Shared Property Manager also implements locks and semaphores to protect shared properties from simultaneous access, which could result in lost updates and could leave the properties in an unpredictable state.

Shared properties can be shared only by objects running in the same process. If you want instances of different components to share properties, you have to install the components in the same MTS package. Because there is a risk that administrators will move components from one package to another, it's safest to limit the use of a shared property group to instances of components that are defined in the same DLL.

It's also important for components sharing properties to have the same activation attribute. If two components in the same package have different activation attributes, they generally won't be able to share properties. For example, if one component is configured to run in a client's process and the other is configured to run in a server process, their objects will usually run in different processes, even though they're in the same package.

You should always instantiate the SharedPropertyGroupManager, SharedPropertyGroup, and SharedProperty objects from MTS objects rather than from a base client. If a base client creates shared property groups and properties, the shared properties are inside the base client's process, not in a server process. This means MTS objects can't share the properties unless the objects, too, are running in the client's process (which is generally not a good idea).

Note   When you set the isolation mode to LockMethod, the Shared Property Manager requires access to the calling object's ObjectContext. You can't use this isolation mode to create a shared property group from within an object's constructor or from a non-MTS object because ObjectContext isn't available during object construction and a non-MTS object doesn't have an ObjectContext.

The ISharedPropertyGroupManager interface exposes the following methods and properties.

Method	Description
CreatePropertyGroup	Creates a new SharedPropertyGroup with a string name as an identifier. If a group with the specified name already exists, CreatePropertyGroup returns a reference to the existing group.
get_Group	Returns a reference to an existing shared property group, given a string name by which it can be identified.
get__NewEnum	Returns a reference to an enumerator that iterates through a list of all the shared property groups in a given process.
See Also

Sharing State


ISharedPropertyGroupManager::CreatePropertyGroup Method

Creates and returns a reference to a new shared property group. If a property group with the specified name already exists, CreatePropertyGroup returns a reference to the existing group.

Provided By

ISharedPropertyGroupManager Interface

HRESULT ISharedPropertyGroup::CreatePropertyGroup (

BSTR name,

LONG* plIsoMode,

LONG* plRelMode,

VARIANT_BOOL* pfExists,

ISharedPropertyGroup** ppGroup,

);

Parameters

name
[in] The name of the shared property group to create.

plIsoMode
[in, out] A reference to a LONG that specifies the isolation mode for the properties in the new shared property group. See the table that lists plIsoMode constants later in this topic. If the value of the pfExists parameter is set to VARIANT_TRUE on return from this method, the plIsoMode value you passed in is ignored and the value returned in this parameter is the isolation mode that was assigned when the property group was created.

plRelMode
[in, out] A reference to a LONG that specifies the release mode for the properties in the new shared property group. See the table that lists plRelMode constants later in this topic. If the value of the pfExists parameter is set to VARIANT_TRUE on return from this method, the plRelMode value you passed in is ignored and the value returned in this parameter is the release mode that was assigned when the property group was created.

pfExists
[out] A reference to a BOOL that's set to VARIANT_TRUE on return from this method if the shared property group specified in the name parameter existed prior to this call, and VARIANT_FALSE if the property group was created by this call.

ppGroup
[out] A reference to a shared property group identified by the BSTR passed in the name parameter, or NULL if an error is encountered.

Settings

The following constants are used in the plIsoMode parameter to specify the effective isolation mode for a shared property group.

Constant	Value	Description
LockSetGet	0	Default. Locks a property during a get_Value or put_Valuecall, assuring that every get or set operation on a shared property is atomic. This ensures that two clients can't read or write to the same property at the same time, but it doesn't prevent other clients from concurrently accessing other properties in the same group.
LockMethod	1	Locks all of the properties in the shared property group for exclusive use by the caller as long as the caller's current method is executing. This is the appropriate mode to use when there are interdependencies among properties, or in cases where a client may have to update a property immediately after reading it before it can be accessed again.
Note   When you set the isolation mode to LockMethod, the Shared Property Manager requires access to the calling object's ObjectContext. You can't use this isolation mode to create a shared property group from within an object's constructor or from a non-MTS object because ObjectContext isn't available during object construction and a base client doesn't have an ObjectContext.

The following constants are used in the plRelMode parameter to specify the effective release mode for a shared property group.

Constant	Value	Description
Standard	0	When all clients have released their references on the property group, the property group is automatically destroyed. (This is the default COM mode.)
Process	1	The property group isn't destroyed until the process in which it was created has terminated.  (Objects that hold references on a property group must still call Release on their references).
Return Values

S_OK
A reference to the shared property group specified in the name parameter is returned in the ppGroup parameter.

CONTEXT_E_NOCONTEXT
The caller isn't executing under the MTS run-time environment. A caller must be executing under MTS to use the Shared Property Manager.

E_INVALIDARG
At least one of the parameters is invalid, or the same object is attempting to create the same property group more than once.

Remarks

The CreatePropertyGroup method sets the value in pfExists to VARIANT_TRUE if the property group it returns in the ppGroup parameter existed prior to the current call. This occurs when another object in the same process has already called CreatePropertyGroup with the same property group name. The CreatePropertyGroup method sets the value in pfExists to  VARIANT_FALSE if the returned property group was created by the current call.

The isolation mode and release mode are assigned when the property group is originally created and aren't changed if a subsequent call passes different values in these parameters. The caller should always check the value of pfExists on return from this method. If pfExists is set to  VARIANT_TRUE, the caller should check the values returned in plIsoMode and plRelMode to determine the isolation and release modes in effect for the property group. For example:

hr = pPropGpMgr->CreatePropertyGroup(stName,

&lIsolationMode, &lReleaseMode, &fAlreadyExists,

&pPropGp);

if (fAlreadyExists) {

if ((lIsolationMode != LockMethod) ||

(lReleaseMode != Process)) {

// Do something appropriate.

}

}

If*

Note   An object should never attempt to pass a shared property group reference to another object. If the reference is passed outside of the object that acquired it, it's no longer a valid reference.

Example

See Also

Sharing State, IObjectContext Interface, ISharedPropertyGroup Interface


ISharedPropertyGroupManager::get_Group Method

Returns a reference to an existing shared property group.

Provided By

ISharedPropertyGroupManager Interface

HRESULT ISharedPropertyGroupManager::get_Group (

BSTR name,

ISharedPropertyGroup** ppGroup,

);

Parameters

name
[in] The name of the shared property group to retrieve.

ppGroup
[out] A reference to the shared property group specified in the name parameter, or NULL if the property group doesn't exist.

Return Values

S_OK
The shared property group exists, and a reference to it is returned in the ppGroup parameter.

E_INVALIDARG
The shared property group with the name specified in the name parameter doesn't exist.

Example

See Also

Sharing State, ISharedPropertyGroupManager Interface


ISharedPropertyGroupManager::get__NewEnum Method

Returns a reference to an enumerator that you can use to iterate through all the shared property groups in a process.

Provided By

ISharedPropertyGroupManager Interface

HRESULT ISharedPropertyGroupManager::get__NewEnum (

IUnknown** ppEnumerator

);

Parameters

ppEnumerator
[out] A reference to the IUnknown interface on a new enumerator object that you can use to iterate through the list of all the shared property groups in the process.

Return Values

S_OK
A reference to the requested enumerator is returned in the ppEnumerator parameter.

Remarks

You use the get__NewEnum method to obtain a reference to an enumerator object. You should immediately call QueryInterface on the returned IUnknown for the IEnumVARIANT interface. This interface exposes several methods you can use to iterate through a list of BSTRs representing shared property group names. Once you have a name, you can use the get_Group method to obtain a reference to the shared property group it represents.

As with any COM object, you must release an enumerator object when you're finished using it. When you enumerate the shared property groups, all groups will be included. However, if you then call CreatePropertyGroup to add a new group, the existing enumerator won't include the new group even if you call Reset or Clone. To include the new group, you must create a new enumerator by calling get__NewEnum again.

Note   get__NewEnum has two underscore characters between get and NewEnum.

Example

See Also

ISharedPropertyGroupManager::get_Group Method, ISharedPropertyGroup Interface


ISharedPropertyGroupManager::get__NewEnum Method Example

#include <mtxspm.h>

ISharedPropertyGroupManager* pspgm = NULL;

IUnknown* pUnknown = NULL;

IEnumVARIANT* pEnum = NULL;

VARIANT v;

ULONG cElementsFetched;

int i;

HRESULT hr;

// Get the enumerator object.

hr = pspgm->get__NewEnum(&pUnknown);

// Query for the IEnumVARIANT interface.

hr = pUnknown->QueryInterface(IID_IEnumVARIANT, (void**) &pEnum);

// Use the enumerator to iterate through

// the property group names.

for(i = 0; i < 10; i++)

{

VariantInit(&v);

pEnum->Next(1, &v, &cElementsFetched);

// Do something with the returned

// property group names.

}


ISharedPropertyGroup Interface

The ISharedPropertyGroup interface is used to create and access the shared properties in a shared property group.

Remarks

The header file for the ISharedPropertyGroup interface is mtxspm.h. You must also link mtxguid.lib to your project to use this interface.

You can access the ISharedPropertyGroup interface by creating a SharedPropertyGroup object with the ISharedPropertyGroupManager::CreatePropertyGroup method.

As with any COM object, you must release a SharedPropertyGroup object when you're finished using it.

The ISharedPropertyGroup interface exposes the following methods.

CreateProperty	Creates a new shared property identified by a string expression that's unique within its property group.
CreatePropertyByPosition	Creates a new shared property identified by a numeric index within its property group.
get_Property	Returns a reference to a shared property, given the string name by which the property is identified.
get_PropertyByPosition	Returns a reference to a shared property, given its numeric index in the shared property group.
See Also

Sharing State, ISharedPropertyGroupManager Interface


ISharedPropertyGroup::CreateProperty Method

Creates and returns a reference to a new SharedProperty with a specified name. If a shared property by that name already exists, CreateProperty returns a reference to the existing property.

Provided By

ISharedPropertyGroup Interface

HRESULT ISharedPropertyGroup::CreateProperty (

BSTR name,

VARIANT_BOOL* pfExists;

ISharedProperty** ppProp,

);

Parameters

name
[in] The name of the property to create. You can use this name later to obtain a reference to this property by using the get_Property method.

pfExists
[out] A reference to a Boolean value that's set to VARIANT_TRUE on return from this method if the shared property specified in the name parameter existed prior to this call, and VARIANT_FALSE if the property was created by this call.

ppProp
[out] A reference to a SharedProperty object with the name specified in the name parameter, or NULL if an error is encountered.

Return Values

S_OK
A reference to a shared property with the name specified in the name parameter is returned in the parameter ppProp.

E_INVALIDARG
One or more of the arguments passed in is invalid.

Remarks

When you create a shared property, its value is set to the default, which is a VARIANT of type VT_I4, with a value of 0.

If you create a shared property with the CreateProperty method, you can access that property only by using the get_Property method. You can't assign a numeric index to the same property and then access it by using the get_PropertyByPosition method.

The same shared property group can contain some shared property objects that are identified by name and others that are identified by position.

Example

See Also

Sharing State, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_PropertyByPosition Method, ISharedPropertyGroup::get_Property Method


ISharedPropertyGroup::CreatePropertyByPosition Method

Creates a new shared property identified by a numeric index that's unique within the property group. If a shared property with the specified index already exists, CreatePropertyByPosition returns a reference to the existing one.

Provided By

ISharedPropertyGroup Interface

HRESULT ISharedPropertyGroup::CreatePropertyByPosition (

INT index,

VARIANT_BOOL* pfExists;

ISharedProperty** ppProp,

);

Parameters

index
[in] The numeric index within the SharedPropertyGroup by which the new property will be referenced. You can use this index later to retrieve the shared property with the get_PropertyByPosition method.

pfExists
[out] A reference to a Boolean value. If pfExists is set to VARIANT_TRUE on return from this method, the shared property specified by index existed prior to this call. If it's set to VARIANT_FALSE, the property was created by this call.

ppProp
[out] A reference to a shared property object identified by the numeric index passed in the index parameter, or NULL if an error is encountered.

Return Values

S_OK
A reference to the shared property occupying the position specified in the index parameter is returned in the ppProp parameter.

E_INVALIDARG
One or more of the arguments passed in is invalid.

Remarks

When you create a shared property, its value is set to the default, which is a VARIANT of type VT_I4, with a value of 0.

If you create a SharedProperty object with the CreatePropertyByPosition method, you can access that property only by using the get_PropertyByPosition method. You can't assign a string name to the same property and then access it by using the get_Property method. Accessing a property by position is faster than accessing a property by using a string name because it requires less overhead.

The same shared property group can contain some SharedProperty objects that are identified by position and others that are identified by name.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::get_PropertyByPosition Method, ISharedPropertyGroup::get_Property Method


ISharedPropertyGroup::CreatePropertyByPosition Method Example

#include <mtx.h>

#include <mtxspm.h>

IObjectContext* pObjectContext = NULL;

ISharedPropertyGroupManager* pPropGpMgr = NULL;

ISharedPropertyGroup* pPropGp = NULL;

ISharedProperty* pPropNextNum = NULL;

VARIANT_BOOL fAlreadyExists = VARIANT_FALSE;

LONG lIsolationMode = LockMethod;

LONG lReleaseMode = Process;

BSTR stName;

VARIANT vNext;

LONG lNextValue = 0L;

HRESULT hr = S_OK;

hr = GetObjectContext(&pObjectContext);

// Create the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

hr = pObjectContext->CreateInstance

(CLSID_SharedPropertyGroupManager,

IID_ISharedPropertyGroupManager,

(void**)&pPropGpMgr);

stName = SysAllocString(L"Counter");

hr = pPropGpMgr->CreatePropertyGroup(stName,

&lIsolationMode, &lReleaseMode, &fAlreadyExists,

&pPropGp);

SysFreeString(stName);

hr = pPropGp->CreatePropertyByPosition

(0, &fAlreadyExists, &pPropNextNum);

// Get the next number and increment the counter.

VariantInit(&vNext);

vNext.vt = VT_I4;

hr = pPropNextNum->get_Value(&vNext);

lNextValue = vNext.lVal++;

hr = pPropNextNum->put_Value(vNext);


ISharedPropertyGroup::get_Property Method

Returns a reference to an existing shared property identified by a string name.

Provided By

ISharedPropertyGroup Interface

HRESULT ISharedPropertyGroup::get_Property (

BSTR name,

ISharedProperty** ppProperty,

);

Parameters

name
[in] The name of the shared property to retrieve.

ppProperty
[out] A reference to the shared property specified in the name parameter, or NULL if the property doesn't exist.

Return Values

S_OK
The shared property specified by name was found and a reference to it is returned in the ppProperty parameter.

E_INVALIDARG
Either the argument passed in the ppProperty parameter was a null pointer, or there is no property in the shared property group with the name specified in the name parameter.

Remarks

You can use only the get_Property method to access properties that were created with the CreateProperty method. To access properties that were created with the CreatePropertyByPosition method, use the get_PropertyByPosition method.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_PropertyByPosition Method


ISharedPropertyGroupManager::get_Group, ISharedPropertyGroup::get_Property Methods Example

#include <mtx.h>

#include <mtxspm.h>

IObjectContext* pObjectContext = NULL;

ISharedPropertyGroupManager* pPropGpMgr = NULL;

ISharedPropertyGroup* pPropGp = NULL;

ISharedProperty* pPropNextNum = NULL;

BSTR stName, stNextNumber;

VARIANT vNext;

LONG lNextValue = 0L;

HRESULT hr = S_OK;

hr = GetObjectContext(&pObjectContext);

// Get the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

hr = pObjectContext->CreateInstance

(CLSID_SharedPropertyGroupManager,

IID_ISharedPropertyGroupManager,

(void**)&pPropGpMgr);

stName = SysAllocString(L"Counter");

hr = pPropGpMgr->get_Group(stName, &pPropGp);

SysFreeString(stName);

stNextNumber = SysAllocString(L"NextNum");

hr = pPropGp->get_Property

(stNextNumber, &pPropNextNum);

SysFreeString(stNextNumber);

// Get the next number and increment the counter.

VariantInit(&vNext);

vNext.vt = VT_I4;

hr = pPropNextNum->get_Value(&vNext);

lNextValue = vNext.lVal++;

hr = pPropNextNum->put_Value(vNext);


ISharedPropertyGroup::get_PropertyByPosition Method

Returns a reference to an existing shared property identified by its numeric index within the property group.

Provided By

ISharedPropertyGroup Interface

HRESULT ISharedPropertyGroup::get_PropertyByPosition (

INT index,

ISharedProperty** ppProperty,

);

Parameters

index
[in] The numeric index within the SharedPropertyGroup of the property to retrieve.

ppProperty
[out] A reference to the shared property specified by the index parameter, or NULL if the property doesn't exist.

Return Values

S_OK
The shared property specified by index was found and a reference to it is returned in the ppProperty parameter.

E_INVALIDARG
Either the argument passed in the ppProperty parameter was a null pointer, or there is no property in the shared property group with the index number specified in the index parameter.

Remarks

You can use only the get_PropertyByPosition method to access properties that were created with the CreatePropertyByPosition method. To access properties that were created with the CreateProperty method, use the get_Property method.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_Property Method


ISharedPropertyGroup::get_PropertyByPosition Method Example

#include <mtx.h>

#include <mtxspm.h>

IObjectContext* pObjectContext = NULL;

ISharedPropertyGroupManager* pPropGpMgr = NULL;

ISharedPropertyGroup* pPropGp = NULL;

ISharedProperty* pPropNextNum = NULL;

BSTR stName;

VARIANT vNext;

LONG lNextValue = 0L;

HRESULT hr = S_OK;

hr = GetObjectContext(&pObjectContext);

// Get the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

hr = pObjectContext->CreateInstance

(CLSID_SharedPropertyGroupManager,

IID_ISharedPropertyGroupManager,

(void**)&pPropGpMgr);

stName = SysAllocString(L"Counter");

hr = pPropGpMgr->get_Group(stName, &pPropGp);

SysFreeString(stName);

hr = pPropGp->get_PropertyByPosition

(0, &pPropNextNum);

// Get the next number and increment the counter.

VariantInit(&vNext);

vNext.vt = VT_I4;

hr = pPropNextNum->get_Value(&vNext);

lNextValue = vNext.lVal++;

hr = pPropNextNum->put_Value(vNext);


ISharedProperty Interface

The ISharedProperty interface is used to set or retrieve the value of a shared property. A shared property can contain any data type that can be represented by a variant.

Remarks

The header file for the ISharedProperty interface is mtxspm.h. You must also link mtxguid.lib to your project to use this interface.

You can access the ISharedProperty interface by creating a SharedProperty object with the ISharedPropertyGroup::CreateProperty method or the ISharedPropertyGroup::CreatePropertyByPosition method.

A SharedProperty object can be created or accessed only from within a SharedPropertyGroup.

As with any COM object, you must release a SharedProperty object when you're finished using it.

The ISharedProperty interface exposes the following methods.

Method	Description
get_Value	Retrieves the value of a shared property.
put_Value	Sets the value of a shared property.
See Also

Sharing State, MTS Supported Variant Types


ISharedProperty::get_Value Method

Retrieves the value of a shared property.

Provided By

ISharedProperty Interface

HRESULT ISharedProperty::get_Value (

VARIANT* pVal

);

Parameters

pVal
[out] A reference to a variant in which the value of the shared property will be returned.

Return Values

S_OK
A reference to a VARIANT containing the value of the shared property is returned in the pVal parameter.

E_INVALIDARG
The argument passed in the pval parameter is invalid.

Example

See Also

MTS Supported Variant Types, Sharing State


ISharedProperty::put_Value Method

Assigns a value to a shared property.

Provided By

ISharedProperty Interface

HRESULT ISharedProperty::put_Value (

VARIANT value

);

Parameters

value
[in] A VARIANT containing the value to assign to the SharedProperty object.

Return Values

S_OK
The shared property's value has been set to value.

E_INVALIDARG
The argument passed in the value parameter has the VT_BYREF bit set.

DISP_E_ARRAYISLOCKED
The argument passed in the value parameter contains an array that's locked.

DISP_E_BADVARTYPE
The argument passed in the value parameter isn't a valid VARIANT type.

Example

See Also

MTS Supported Variant Types, Sharing State


CreatePropertyGroup, CreateProperty, put_Value, get_Value Methods Example

#include <mtx.h>

#include <mtxspm.h>

IObjectContext* pObjectContext = NULL;

ISharedPropertyGroupManager* pPropGpMgr = NULL;

ISharedPropertyGroup* pPropGp = NULL;

ISharedProperty* pPropNextNum = NULL;

VARIANT_BOOL fAlreadyExists = VARIANT_FALSE;

LONG lIsolationMode = LockMethod;

LONG lReleaseMode = Process;

LONG lNextValue = 0L;

BSTR stName, stNextNumber;

VARIANT vNext;

HRESULT hr = S_OK;

hr = GetObjectContext(&pObjectContext);

// Create the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

hr = pObjectContext->CreateInstance

(CLSID_SharedPropertyGroupManager,

IID_ISharedPropertyGroupManager,

(void**)&pPropGpMgr);

stName = SysAllocString(L"Counter");

hr = pPropGpMgr->CreatePropertyGroup(stName,

&lIsolationMode, &lReleaseMode, &fAlreadyExists,

&pPropGp);

SysFreeString(stName);

stNextNumber = SysAllocString(L"NextNum");

hr = pPropGp->CreateProperty

(stNextNumber, &fAlreadyExists, &pPropNextNum);

SysFreeString(stNextNumber);

// Get the next number and increment the counter.

VariantInit(&vNext);

vNext.vt = VT_I4;

hr = pPropNextNum->get_Value(&vNext);

lNextValue = vNext.lVal++;

hr = pPropNextNum->put_Value(vNext);


ISharedPropertyGroupManager Interface

The ISharedPropertyGroupManager interface is used to create shared property groups and to obtain access to existing shared property groups.

Remarks

The ISharedPropertyGroupManager interface is declared in the package com.ms.mtx.

You can access the ISharedPropertyGroupManager interface by creating an instance of the SharedPropertyGroupManager by using either IObjectContext.CreateInstance or new SharedPropertyGroupManager. It makes no difference which you use.

CreateInstance method of the ObjectContext object. It makes no difference which you use.

The Shared Property Manager is a resource dispenser that you can use to share state among multiple objects within a server process. You can't use global variables in a distributed environment because of concurrency and name collision issues. The Shared Property Manager eliminates name collisions by providing shared property groups, which establish unique name spaces for the shared properties they contain. The Shared Property Manager also implements locks and semaphores to protect shared properties from simultaneous access, which could result in lost updates and could leave the properties in an unpredictable state.

Shared properties can be shared only by objects running in the same process. If you want instances of different components to share properties, you have to install the components in the same MTS package. Because there is a risk that administrators will move components from one package to another, it's safest to limit the use of a shared property group to instances of components that are defined in the same DLL.

It's also important for components sharing properties to have the same activation attribute. If two components in the same package have different activation attributes, they generally won't be able to share properties. For example, if one component is configured to run in a client's process and the other is configured to run in a server process, their objects will usually run in different processes, even though they're in the same package.

You should always instantiate the SharedPropertyGroupManager, SharedPropertyGroup, and SharedProperty objects from MTS objects rather than from a base client. If a base client creates shared property groups and properties, the shared properties are inside the base client's process, not in a server process. This means MTS objects can't share the properties unless the objects, too, are running in the client's process (which is generally not a good idea).

Note   When you set the isolation mode to LOCKMODE_METHOD, the Shared Property Manager requires access to the calling object's ObjectContext. You can't use this isolation mode to create a shared property group from within an object's constructor or from a non-MTS object because ObjectContext isn't available during object construction and a non-MTS object doesn't have an ObjectContext.

The ISharedPropertyGroupManager interface exposes the following methods and properties.

Method	Description
CreatePropertyGroup	Creates a new SharedPropertyGroup with a string name as an identifier. If a group with the specified name already exists, CreatePropertyGroup returns a reference to the existing group.
getGroup	Returns a reference to an existing shared property group, given a string name by which it can be identified.
get_NewEnum	Returns a reference to an enumerator that iterates through a list of all the shared property groups in a given process.
See Also

Sharing State


ISharedPropertyGroupManager.CreatePropertyGroup Method

Creates and returns a reference to a new shared property group. If a property group with the specified name already exists, CreatePropertyGroup returns a reference to the existing group.

Provided By

ISharedPropertyGroupManager Interface

ISharedPropertyGroup CreatePropertyGroup (

String name,

int[] lockmode,

int[]  releasemode,

boolean[] exists,

);

Parameters

name
[in] The name of the shared property group to create.

lockmode
[in, out] An array of one integer that specifies the isolation mode for the properties in the new shared property group. See the table that lists lockmode constants later in this topic. If the value of the exists parameter is set to true on return from this method, the lockmode value you passed in is ignored and the value returned in this parameter is the isolation mode that was assigned when the property group was created.

releasemode
[in, out] An array of one integer that specifies the release mode for the properties in the new shared property group. See the table that lists releasemode constants later in this topic. If the value of the exists parameter is set to true on return from this method, the releasemode value you passed in is ignored and the value returned in this parameter is the release mode that was assigned when the property group was created.

exists
[out] An array of one boolean that's set to true on return from this method if the shared property group specified in the name parameter existed prior to this call, and false if the property group was created by this call.

Settings

The following constants are used in the lockmode parameter to specify the effective isolation mode for a shared property group. These constants are static final members of the ISharedPropertyGroupManager interface.

Constant	Value	Description
LOCKMODE _SETGET	0	Default. Locks a property during a getValue or putValuecall, assuring that every get or set operation on a shared property is atomic. This ensures that two clients can't read or write to the same property at the same time, but it doesn't prevent other clients from concurrently accessing other properties in the same group.
LOCKMODE _METHOD	1	Locks all of the properties in the shared property group for exclusive use by the caller as long as the caller's current method is executing. This is the appropriate mode to use when there are interdependencies among properties, or in cases where a client may have to update a property immediately after reading it before it can be accessed again.
Note   When you set the isolation mode to LOCKMODE_METHOD, the Shared Property Manager requires access to the calling object's ObjectContext. You can't use this isolation mode to create a shared property group from within an object's constructor or from a non-MTS object because ObjectContext isn't available during object construction and a base client doesn't have an ObjectContext.

The following constants are used in the releasemode parameter to specify the effective release mode for a shared property group. These constants are static final members of the ISharedPropertyGroupManager interface.

Constant	Value	Description
RELEASE MODE_ STANDARD	0	When all clients have released their references on the property group, the property group is automatically destroyed. (This is the default COM mode.)
RELEASE MODE_ PROCESS	1	The property group isn't destroyed until the process in which it was created has terminated.
Return Value

A reference to a shared property group identified by the string expression passed in the name parameter, or null if an error is encountered.

Remarks

The CreatePropertyGroup method sets the value in exists to true if the property group it returns existed prior to the current call. This occurs when another object in the same process has already called CreatePropertyGroup with the same property group name. The CreatePropertyGroup method sets the value in exists to false if the returned property group was created by the current call.

The isolation mode and release mode are assigned when the property group is originally created and aren't changed if a subsequent call passes different values in these parameters. The caller should always check the value of exists on return from this method. If exists is set to true, the caller should check the values returned in lockmode and releasemode to determine the isolation and release modes in effect for the property group. For example:

propGp = propGpMgr.CreatePropertyGroup

("Counter", aiIsolationMode,

aiReleaseMode, afAlreadyExists);

if (afAlreadyExists[0]) {

if ((aiIsolationMode[0] !=

ISharedPropertyGroupManager.LOCKMODE_METHOD) ||

(aiReleaseMode[0] ISharedPropertyGroupManager.

RELEASEMODE_PROCESS)) {

// Do something appropriate.

}

}

If*

Note   An object should never attempt to pass a shared property group reference to another object. If the reference is passed outside of the object that acquired it, it's no longer a valid reference.

Example

See Also

Sharing State, IObjectContext Interface, ISharedPropertyGroup Interface


ISharedPropertyGroupManager.getGroup Method

Returns a reference to an existing shared property group.

Provided By

ISharedPropertyGroupManager Interface

ISharedPropertyGroup getGroup (

String name,

);

Parameters

name
[in] The name of the shared property group to retrieve.

Return Value

A reference to the shared property group specified in the name parameter, or null if the property group doesn't exist.

Example

See Also

Sharing State, ISharedPropertyGroupManager Interface


ISharedPropertyGroupManager.get_NewEnum Method

Returns a reference to an enumerator that you can use to iterate through all the shared property groups in a process.

Provided By

ISharedPropertyGroupManager Interface

IUnknown get_NewEnum ( );

Return Value

A reference to the IUnknown interface on a new enumerator object that you can use to iterate through the list of all the shared property groups in the process.

Remarks

You use the get_NewEnum method to obtain a reference to an enumerator object. You should immediately cast the returned value to the IEnumVariant interface. This interface exposes several methods you can use to iterate through a list of string expressions representing shared property group names. Once you have a name, you can use the getGroup method to obtain a reference to the shared property group it represents. When you enumerate the shared property groups, all groups will be included. However, if you then call CreatePropertyGroup to add a new group, the existing enumerator won't include the new group even if you call Reset or Clone. To include the new group, you must create a new enumerator by calling NewEnum again.

Example

See Also

ISharedPropertyGroupManager.getGroup Method, ISharedPropertyGroup Interface


get_NewEnum Method Example

import com.ms.mtx.*;

ISharedPropertyGroupManager spgm = null;

IEnumVariant myEnum = null;

Variant v;

int i;

// Get the enumerator object and

// cast the returned interface to IEnumVariant.

myEnum = (IEnumVariant)spgm.get_NewEnum();

// Use the enumerator to iterate through

// the property group names.

for(i = 0; i < 10; i++){

v = Enum.Next(1);

// Do something with the returned

// property group names.

}


ISharedPropertyGroup Interface

The ISharedPropertyGroup interface is used to create and access the shared properties in a shared property group.

Remarks

The ISharedPropertyGroup interface is declared in the package com.ms.mtx.

You can access the ISharedPropertyGroup interface by creating a SharedPropertyGroup object with the ISharedPropertyGroupManager.CreatePropertyGroup method.

The ISharedPropertyGroup interface exposes the following methods.

CreateProperty	Creates a new shared property identified by a string expression that's unique within its property group.
CreatePropertyByPosition	Creates a new shared property identified by a numeric index within its property group.
getProperty	Returns a reference to a shared property, given the string name by which the property is identified.
getPropertyByPosition	Returns a reference to a shared property, given its numeric index in the shared property group.
See Also

Sharing State, ISharedPropertyGroupManager Interface


ISharedPropertyGroup.CreateProperty Method

Creates and returns a reference to a new SharedProperty with a specified name. If a shared property by that name already exists, CreateProperty returns a reference to the existing property.

Provided By

ISharedPropertyGroup Interface

ISharedProperty CreateProperty (

String name,

boolean[] exists;

);

Parameters

name
[in] The name of the property to create. You can use this name later to obtain a reference to this property by using the getProperty method.

exists
[out] An array of one Boolean value that's set to true on return from this method if the shared property specified in the name parameter existed prior to this call, and false if the property was created by this call.

Return Value

A reference to a shared property object with the name specified in the name parameter, or null if an error is encountered.

Remarks

When you create a shared property, its value is set to the default, which is a Variant with an integer value of 0.

If you create a shared property with the CreateProperty method, you can access that property only by using the getProperty method. You can't assign a numeric index to the same property and then access it by using the getPropertyByPosition method.

The same shared property group can contain some shared property objects that are identified by name and others that are identified by position.

Example

See Also

Sharing State, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_PropertyByPosition Method, ISharedPropertyGroup::get_Property Method


ISharedPropertyGroup.CreatePropertyByPosition Method

Creates a new shared property identified by a numeric index that's unique within the property group. If a shared property with the specified index already exists, CreatePropertyByPosition returns a reference to the existing one.

Provided By

ISharedPropertyGroup Interface

ISharedProperty CreatePropertyByPosition (

int index,

boolean[] exists;

);

Parameters

index
[in] The numeric index within the SharedPropertyGroup by which the new property will be referenced. You can use this index later to retrieve the shared property with the getPropertyByPosition method.

exists
[out] An array of one boolean value. If exists is set to true on return from this method, the shared property specified by index existed prior to this call. If it's set to false, the property was created by this call.

Return Value

A reference to a shared property object that's identified by the numeric index passed in the index parameter, or null if an error is encountered.

Remarks

When you create a shared property, its value is set to the default, which is a Variant with an integer value of 0.

If you create a SharedProperty object with the CreatePropertyByPosition method, you can access that property only by using the getPropertyByPosition method. You can't assign a string name to the same property and then access it by using the getProperty method. Accessing a property by position is faster than accessing a property by using a string name because it requires less overhead.

The same shared property group can contain some SharedProperty objects that are identified by position and others that are identified by name.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::get_PropertyByPosition Method, ISharedPropertyGroup::get_Property Method


ISharedPropertyGroup.CreatePropertyByPosition Method Example

import com.ms.mtx.*;

ISharedPropertyGroupManager propGpMgr = null;

ISharedPropertyGroup propGp = null;

ISharedProperty propNextNum = null;

Variant vNext;

int iNextValue = 0;

boolean[] afAlreadyExists = new boolean[1];

int[] aiIsolationMode = new int[1];

aiIsolationMode[0] =

ISharedPropertyGroupManager.LOCKMODE_SETGET;

int[] aiReleaseMode = new int[1];

aiReleaseMode[0] =

ISharedPropertyGroupManager.RELEASEMODE_PROCESS;

// Create the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

propGpMgr = new SharedPropertyGroupManager();

propGp = propGpMgr.CreatePropertyGroup

("Counter", aiIsolationMode,

aiReleaseMode, afAlreadyExists);

propNextNum = propGp.CreatePropertyByPosition

(0, fAlreadyExists);

// Get the next number and increment it.

VariantInit(&vNext);

vNext = propNextNum.getValue();

iNextValue = vNext.getInt();

vNext.putInt(iNextValue + 1);

propNextNum.putValue(vNext);


ISharedPropertyGroup.getProperty Method

Returns a reference to an existing shared property identified by a string name.

Provided By

ISharedPropertyGroup Interface

ISharedProperty getProperty (

String name,

);

Parameters

name
[in] A string expression that contains the name of the shared property to retrieve.

Return Value

A reference to the shared property specified in the name parameter, or null if the property doesn't exist.

Remarks

You can use only the getProperty method to access properties that were created with the CreateProperty method. To access properties that were created with the CreatePropertyByPosition method, use the getPropertyByPosition method.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_PropertyByPosition Method


ISharedPropertyGroupManager.getGroup, ISharedPropertyGroup.getProperty Methods Example

import com.ms.mtx.*;

ISharedPropertyGroupManager propGpMgr = null;

ISharedPropertyGroup propGp = null;

ISharedProperty propNextNum = null;

Variant vNext;

int iNextValue = 0;

// Get the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

propGpMgr = new SharedPropertyGroupManager();

propGp = propGpMgr.getGroup("Counter");

propNextNum = propGp.getProperty("NextNum");

// Get the next number and increment it.

VariantInit(&vNext);

vNext = propNextNum.getValue();

iNextValue = vNext.getInt();

vNext.putInt(iNextValue + 1);

propNextNum.putValue(vNext);


ISharedPropertyGroup.getPropertyByPosition Method

Returns a reference to an existing shared property identified by its numeric index within the property group.

Provided By

ISharedPropertyGroup Interface

ISharedProperty getPropertyByPosition (

INT index,

);

Parameters

index
[in] The numeric index within the SharedPropertyGroup of the property to retrieve.

Return Value

A reference to the shared property specified by the index parameter, or null if the property doesn't exist.

Remarks

You can use only the getPropertyByPosition method to access properties that were created with the CreatePropertyByPosition method. To access properties that were created with the CreateProperty method, use the getProperty method.

Example

See Also

Sharing State, ISharedPropertyGroup::CreateProperty Method, ISharedPropertyGroup::CreatePropertyByPosition Method, ISharedPropertyGroup::get_Property Method


ISharedPropertyGroup.getPropertyByPosition Method Example

import com.ms.mtx.*;

ISharedPropertyGroupManager propGpMgr = null;

ISharedPropertyGroup propGp = null;

ISharedProperty propNextNum = null;

Variant vNext;

int iNextValue = 0;

// Get the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

propGpMgr = new SharedPropertyGroupManager();

propGp = propGpMgr.getGroup("Counter");

propNextNum = propGp.getPropertyByPosition(0);

// Get the next number and increment it.

VariantInit(&vNext);

vNext = propNextNum.getValue();

iNextValue = vNext.getInt();

vNext.putInt(iNextValue + 1);

propNextNum.putValue(vNext);


ISharedProperty Interface

The ISharedProperty interface is used to set or retrieve the value of a shared property. A shared property can contain any data type that can be represented by a variant.

Remarks

The ISharedProperty interface is declared in the package com.ms.mtx.

You can access the ISharedProperty interface by creating a SharedProperty object with the ISharedPropertyGroup.CreateProperty method or the ISharedPropertyGroup.CreatePropertyByPosition method.

A SharedProperty object can be created or accessed only from within a SharedPropertyGroup.

The ISharedProperty interface exposes the following methods.

Method	Description
getValue	Retrieves the value of a shared property.
putValue	Sets the value of a shared property.
See Also

Sharing State, MTS Supported Variant Types


ISharedProperty.getValue Method

Retrieves the value of a shared property.

Provided By

ISharedProperty Interface

Variant getValue ( );

Return Value

A Variant in which the value of the shared property will be returned.

Example

See Also

MTS Supported Variant Types, Sharing State


ISharedProperty.putValue Method

Assigns a value to a shared property.

Provided By

ISharedProperty Interface

void putValue (

Variant value

);

Parameters

value
[in] A Variant containing the value to assign to the SharedProperty object.

Example

See Also

MTS Supported Variant Types, Sharing State


CreatePropertyGroup, CreateProperty, putValue, getValue Methods Example

import com.ms.mtx.*;

ISharedPropertyGroupManager propGpMgr = null;

ISharedPropertyGroup propGp = null;

ISharedProperty propNextNum = null;

Variant vNext;

int iNextValue = 0;

boolean[] afAlreadyExists = new boolean[1];

int[] aiIsolationMode = new int[1];

aiIsolationMode[0] =

ISharedPropertyGroupManager.LOCKMODE_SETGET;

int[] aiReleaseMode = new int[1];

aiReleaseMode[0] =

ISharedPropertyGroupManager.RELEASEMODE_PROCESS;

// Create the SharedPropertyGroupManager,

// SharedPropertyGroup, and SharedProperty.

propGpMgr = new SharedPropertyGroupManager();

propGp = propGpMgr.CreatePropertyGroup

("Counter", aiIsolationMode,

aiReleaseMode, afAlreadyExists);

propNextNum = propGp.CreateProperty

("NextNum", afAlreadyExists);

// Get the next number and increment it.

VariantInit(&vNext);

vNext = propNextNum.getValue();

iNextValue = vNext.getInt();

vNext.putInt(iNextValue + 1);

propNextNum.putValue(vNext);


TransactionContext Object

The TransactionContext object is used by a base client to compose the work of one or more MTS objects into an atomic transaction and to commit or abort the transaction.

Remarks

To use the TransactionContext object, you must set a reference to the Transaction Context Type Library (txctx.dll).

You can use a TransactionContext object to scope a transaction from a base client. You begin the transaction by instantiating a TransactionContext object, and you end the transaction by calling Commit or Abort on the object. The base client itself never executes within the transaction.

The TransactionContext component is a standard MTS component. The component's transaction attribute is set to Requires a new transaction, which means that a TransactionContext object is always the root of a transaction. When a base client instantiates an object by using the TransactionContext object's CreateInstance method, the new object and its descendants will participate in theTransactionContext object's transaction unless the new object's transaction attribute is set to Requires a new transaction or Does not support transactions.

You could easily write your own TransactionContext component. You would simply create a component that implements the methods Commit, Abort, and CreateInstance, and set the component's transaction attribute to Requires a new transaction. The three methods would do nothing more than call GetObjectContext and invoke their ObjectContext object's SetComplete, SetAbort, and CreateInstance methods, respectively.

Before you use TransactionContext to compose the work of existing components in a transaction, you should consider implementing a separate component that not only composes their work but encapsulates it into a reusable unit. This new component would not only serve the needs of the current base client, but other clients could also use it. In one approach, the base client instantiates a TransactionContext object, calls its CreateInstance method to instantiate other objects, calls various methods on those objects, and finally calls Commit or Abort on the TransactionContext object. In the other approach, you create a new component that requires a transaction. This new component instantiates the other objects using its ObjectContext object's CreateInstance method, calls the relevant methods on those other objects itself, and then calls SetComplete or SetAbort on its ObjectContext when it's done. Using this approach, the base client only needs to instantiate this one object, and invoke one method on it, and the object does the rest of the work. When other clients require the same functionality, they can reuse the new component.

You obtain a reference to a TransactionContext object with CreateObject. For example:

Set objTransactionContext = _

CreateObject("TxCtx.TransactionContext")

The TransactionContext object provides the following methods.

Method	Description
Abort	Aborts the work of all MTS objects participating in the current transaction. The transaction is completed on return from this method.
Commit	Attempts to commit the work of all MTS objects participating in the current transaction. If any of the MTS objects participating in the transaction have called SetAbort or DisableCommit, or if a system error has occurred, the transaction will be aborted. Otherwise, the transaction will be committed. In either case, the transaction is completed on return from this method.
CreateInstance	Instantiates another MTS object. If the component that provides the object is configured to support or require a transaction, then the new object runs under the transaction of the TransactionContextobject.
See Also

Transaction Context Objects, Base Clients, Transactions


Abort Method

Aborts the current transaction.

Applies To

TransactionContext Object

Syntax

transactioncontextobject.Abort

The transactioncontextobject placeholder represents an object variable that evaluates to a TransactionContext object.

Remarks

When a base client calls Abort, all objects that participated in the transaction are automatically deactivated. Any database updates made by those objects are rolled back. The transaction is completed on return from this method. If another call is made on the TransactionContext object after the TransactionContext object has returned from a call in which it called the Abort method, a new transaction is started.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, SetAbort


Abort, Commit Methods Example

Dim objTxCtx As TransactionContext

Dim objMyObject As MyCompany.MyObject

Dim userCanceled As Boolean

' Get TransactionContext.

Set objTxCtx = _

CreateObject("TxCtx.TransactionContext")

' Create an instance of some component.

Set objMyObject= _

objTxCtx.CreateInstance("MyCompany.MyObject")

' Do some work here.

' If something goes wrong, abort the transaction.

If userCanceled Then

objTxCtx.Abort

' Otherwise, commit it.

Else

objTxCtx.Commit

End If


Commit Method

Attempts to commit the current transaction.

Applies To

TransactionContext Object

Syntax

transactioncontextobject.Commit

The transactioncontextobject placeholder represents an object variable that evaluates to a TransactionContext object.

Remarks

Calling Commit doesn't guarantee that a transaction will be committed. If any MTS object that was part of the transaction has returned from a method after calling SetAbort, the transaction will be aborted. If any object that was part of the transaction has called DisableCommit and hasn't yet called EnableCommit or SetComplete, the transaction will also be aborted. Any error that causes Microsoft Distributed Transaction Coordinator to abort a transaction will also abort an MTS transaction.

When a base client calls Commit, regardless of whether the transaction commits or aborts, the transaction is completed on return from this method and all objects that participated in the transaction are automatically deactivated. If another call comes in after the TransactionContext object has returned from a call in which it called the Commit method, a new transaction is started.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, SetComplete


CreateInstance Method

Instantiates an MTS object that will execute within the scope of the transaction that was initiated with the creation of the TransactionContext object.

Applies To

TransactionContext Object

Syntax

Set object = transactioncontextobject.CreateInstance(programmaticID)

Part

object
An object variable that evaluates to an MTS object.

transactioncontextobject
An object variable that represents the TransactionContext object from which to create the new object.

programmaticID
The programmatic Id of the new object's component.

Remarks

When a base client uses the TransactionContext object's CreateInstance method to instantiate an MTS object, the new object executes within the transaction context object's activity. If the transaction attribute of the new object's component is set to either Supports transactions or Requires a transaction, the new object also inherits the transaction initiated with the creation of the TransactionContext object. However, if the component that provides the new object has its transaction attribute set to Does not support transactions, the object neither inherits the transaction nor passes it on to objects it subsequently creates. If the component that provides the new object has its transaction attribute set to Requires a new transaction, the MTS run-time environment initiates a new transaction for the new object, and that transaction is the one that's inherited by objects it subsequently creates.

In this respect, using CreateInstance is comparable to using CoCreateInstance and specifying NULL for the controlling IUnknown interface (pUnkOuter).

Example

See Also

Transaction Context Objects, Base Clients, Transactions, CreateInstance


CreateInstance Method, TransactionContext Object Example

Dim objTxCtx As TransactionContext

Dim objMyObject As MyCompany.MyObject

' Get TransactionContext.

Set objTxCtx = _

CreateObject("TxCtx.TransactionContext")

' Create an instance of MyObject.

Set objMyObject= _

objTxCtx.CreateInstance("MyCompany.MyObject")


ITransactionContextEx Interface

The ITransactionContextEx interface is used by a base client to compose the work of one or more MTS objects into an atomic transaction and to commit or abort the transaction.

Remarks

The header file for the ITransactionContextEx interface is txctx.h. You must also link mtxguid.lib to your project to use this interface.

You can use a TransactionContextEx object to scope a transaction from a base client. You begin the transaction by instantiating a TransactionContextEx object, and you end the transaction by calling Commit or Abort on the object. The base client itself never executes within the transaction.

The TransactionContextEx component is a standard MTS component. The component's transaction attribute is set to Requires a new transaction, which means that a TransactionContextEx object is always the root of a transaction. When a base client instantiates an object by using the ITransactionContextEx::CreateInstance method, the new object and its descendants will participate in theTransactionContextEx object's transaction unless the new object's transaction attribute is set to Requires a new transaction or Does not support transactions.

You could easily write your own TransactionContextEx component. You would simply create a component that implements the methods Commit, Abort, and CreateInstance, and set the component's transaction attribute to Requires a new transaction. The three methods would do nothing more than call GetObjectContext and invoke their ObjectContext object's SetComplete, SetAbort, and CreateInstance methods, respectively.

Before you use TransactionContextEx to compose the work of existing components in a transaction, you should consider implementing a separate component that not only composes their work but encapsulates it into a reusable unit. This new component would not only serve the needs of the current base client, but other clients could also use it. In one approach, the base client instantiates a TransactionContextEx object, calls its CreateInstance method to instantiate other objects, calls various methods on those objects, and finally calls Commit or Abort on the TransactionContextEx object. In the other approach, you create a new component that requires a transaction. This new component instantiates the other objects using its ObjectContext object's CreateInstance method, calls the relevant methods on those other objects itself, and then calls SetComplete or SetAbort on its ObjectContext when it's done. Using this approach, the base client only needs to instantiate this one object, and invoke one method on it, and the object does the rest of the work. When other clients require the same functionality, they can reuse the new component.

You obtain a reference to the ITransactionContextEx interface by creating a TransactionContextEx object with a call to CoCreateInstance. For example:

CoCreateInstance(CLSID_TransactionContextEx, NULL, CLSCTX_INPROC,
IID_ITransactionContextEx, (void**)&m_pTransactionContext);

The ITransactionContextEx interface exposes the following methods.

Method	Description
Abort	Aborts the work of all MTS objects participating in the current transaction. The transaction is completed on return from this method.
Commit	Attempts to commit the work of all MTS objects participating in the current transaction. If any of the MTS objects participating in the transaction have called SetAbort or DisableCommit, or if a system error has occurred, the transaction will be aborted. Otherwise, the transaction will be committed. In either case, the transaction is completed on return from this method.
CreateInstance	Instantiates another MTS object. If the component that provides the object is configured to support or require a transaction, then the new object runs under the transaction of the TransactionContextExobject.
See Also

Transaction Context Objects, Base Clients, Transactions


ITransactionContextEx::Abort Method

Aborts the current transaction.

Provided By

ITransactionContextEx Interface

HRESULT ITransactionContextEx::Abort ( );

Return Values

S_OK
The transaction was aborted.

E_FAIL
The TransactionContextEx object isn't running under a MTS process. This could happen if the TransactionContextEx component's Registry entry has been corrupted.

E_UNEXPECTED
An unexpected error occurred.

Remarks

When a base client calls Abort, all objects that participated in the transaction are automatically deactivated. Any database updates made by those objects are rolled back. The transaction is completed on return from this method. If another call is made on the TransactionContextEx object after the TransactionContextEx object has returned from a call in which it called the Abort method, a new transaction is started.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, SetAbort


ITransactionContextEx::Abort, ITransactionContextEx::Commit Methods Example

#include <Txctx.h>

ITransactionContextEx* pTransactionContext = NULL;

IMyObject* pMyObject = NULL;

boolean bUserCanceled = FALSE;

HRESULT hr;

// Get TransactionContextEx.

hr = CoCreateInstance(CLSID_ITransactionContextEx,

NULL, CLSCTX_INPROC, IID_ITransactionContextEx,

(void**) &pTransactionContext);

// Create an instance of MyObject.

hr = pTransactionContext->CreateInstance

(CLSID_CMyObject, IID_IMyObject,

(void**) &pMyObject);

// Do some work here.

// If something goes wrong, abort the transaction.

if (bUserCanceled)

pTransactionContext->Abort();

// Otherwise, commit it.

else

pTransactionContext->Commit();


ITransactionContextEx::Commit Method

Attempts to commit the current transaction.

Provided By

ITransactionContextEx Interface

HRESULT ITransactionContextEx::Commit ( );

Return Values

S_OK
The transaction was committed.

E_FAIL
The TransactionContextEx object isn't running under a MTS process. This could happen if the TransactionContextEx component's Registry entry has been corrupted.

E_UNEXPECTED
An unexpected error occurred.

CONTEXT_E_ABORTED
The transaction was aborted.

Remarks

Calling Commit doesn't guarantee that a transaction will be committed. If any MTS object that was part of the transaction has returned from a method after calling SetAbort, the transaction will be aborted. If any object that was part of the transaction has called DisableCommit and hasn't yet called EnableCommit or SetComplete, the transaction will also be aborted. Any error that causes Microsoft Distributed Transaction Coordinator to abort a transaction will also abort an MTS transaction.

When a base client calls Commit, regardless of whether the transaction commits or aborts, the transaction is completed on return from this method and all objects that participated in the transaction are automatically deactivated. If another call comes in after the TransactionContextEx object has returned from a call in which it called the Commit method, a new transaction is started.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, SetComplete


ITransactionContextEx::CreateInstance Method

Instantiates an MTS object that will execute within the scope of the transaction that was initiated with the creation of the TransactionContextEx object.

Provided By

ITransactionContextEx Interface

HRESULT ITransactionContextEx::CreateInstance (

REFCLSID rclsid,

REFIID riid,

LPVOID FAR* ppvObj

);

Parameter

rclsid
[in] A reference to the CLSID of the type of object to instantiate.

riid
[in] A reference to the interface ID of the interface through which you want to communicate with the new object.

ppvObj
[out] A reference to a new object of the type specified by the rclsid argument, through the interface specified by the riid argument.

Return Values

S_OK
A reference to the object is returned in the ppvObj parameter.

REGDB_E_CLASSNOTREG
The component specified by rclsid is not registered as a COM component.

E_OUTOFMEMORY
There's not enough memory available to instantiate the object.

E_INVALIDARG
The argument passed in the ppvObj parameter is invalid.

E_UNEXPECTED
An unexpected error occurred.

Remarks

When a base client uses the ITransactionContextEx::CreateInstance method to instantiate an MTS object, the new object executes within the transaction context object's activity. If the transaction attribute of the new object's component is set to either Supports transactions or Requires a transaction, the new object also inherits the transaction initiated with the creation of the TransactionContextEx object. However, if the component that provides the new object has its transaction attribute set to Does not support transactions, the object neither inherits the transaction nor passes it on to objects it subsequently creates. If the component that provides the new object has its transaction attribute set to Requires a new transaction, the MTS run-time environment initiates a new transaction for the new object, and that transaction is the one that's inherited by objects it subsequently creates.

If the Microsoft Distributed Transaction Coordinator is not running and the object is transactional, the object is successfully created. However, method calls to that object will fail with CONTEXT_E_TMNOTAVAILABLE. Objects cannot recover from this condition and should be released.

MTS always uses standard marshaling. Even if a component exposes the IMarshal interface, its IMarshal methods will never be called by the MTS run-time environment.

Note   You can't create MTS objects as part of an aggregation. In this respect, using CreateInstance is comparable to using CoCreateInstance and specifying NULL for the controlling IUnknown interface (pUnkOuter).

Example

See Also

Transaction Context Objects, Base Clients, Transactions, CreateInstance


ITransactionContextEx::CreateInstance Method Example

#include <Txctx.h>

ITransactionContextEx* pTransactionContext = NULL;

IMyObject* pMyObject = NULL;

HRESULT hr;

// Get TransactionContextEx.

hr = CoCreateInstance(CLSID_ITransactionContextEx,

NULL, CLSCTX_INPROC, IID_ITransactionContextEx,

(void**) &pTransactionContext);

// Create an instance of MyObject.

hr = pTransactionContext->CreateInstance

(CLSID_CMyObject, IID_IMyObject,

(void**) &pMyObject);


ITransactionContextEx Interface

The ITransactionContextEx interface is used by a base client to compose the work of one or more MTS objects into an atomic transaction and to commit or abort the transaction.

Remarks

The ITransactionContextEx interface is declared in the package com.ms.mtx.

You can use a TransactionContextEx object to scope a transaction from a base client. You begin the transaction by instantiating a TransactionContextEx object, and you end the transaction by calling Commit or Abort on the object. The base client itself never executes within the transaction.

The TransactionContextEx component is a standard MTS component. The component's transaction attribute is set to Requires a new transaction, which means that a TransactionContextEx object is always the root of a transaction. When a base client instantiates an object by using the ITransactionContextEx.CreateInstance method, the new object and its descendants will participate in theTransactionContextEx object's transaction unless the new object's transaction attribute is set to Requires a new transaction or Does not support transactions.

You could easily write your own TransactionContextEx component. You would simply create a component that implements the methods Commit, Abort, and CreateInstance, and set the component's transaction attribute to Requires a new transaction. The three methods would do nothing more than call GetObjectContext and invoke their ObjectContext object's SetComplete, SetAbort, and CreateInstance methods, respectively.

Before you use TransactionContextEx to compose the work of existing components in a transaction, you should consider implementing a separate component that not only composes their work but encapsulates it into a reusable unit. This new component would not only serve the needs of the current base client, but other clients could also use it. In one approach, the base client instantiates a TransactionContextEx object, calls its CreateInstance method to instantiate other objects, calls various methods on those objects, and finally calls Commit or Abort on the TransactionContextEx object. In the other approach, you create a new component that requires a transaction. This new component instantiates the other objects using its ObjectContext object's CreateInstance method, calls the relevant methods on those other objects itself, and then calls SetComplete or SetAbort on its ObjectContext when it's done. Using this approach, the base client only needs to instantiate this one object, and invoke one method on it, and the object does the rest of the work. When other clients require the same functionality, they can reuse the new component.

You obtain a reference to the ITransactionContextEx interface by creating a TransactionContextEx object. For example:

new TransactionContextEx();

The ITransactionContextEx interface exposes the following methods.

Method	Description
Abort	Aborts the work of all MTS objects participating in the current transaction. The transaction is completed on return from this method.
Commit	Attempts to commit the work of all MTS objects participating in the current transaction. If any of the MTS objects participating in the transaction have called SetAbort or DisableCommit, or if a system error has occurred, the transaction will be aborted. Otherwise, the transaction will be committed. In either case, the transaction is completed on return from this method.
CreateInstance	Instantiates another MTS object. If the component that provides the object is configured to support or require a transaction, then the new object runs under the transaction of the TransactionContextExobject.
See Also

Transaction Context Objects, Base Clients, Transactions


ITransactionContextEx.Abort Method

Aborts the current transaction.

Provided By

ITransactionContextEx Interface

void Abort ( );

Remarks

When a base client calls Abort, all objects that participated in the transaction are automatically deactivated. Any database updates made by those objects are rolled back. The transaction is completed on return from this method. If another call is made on the TransactionContextEx object after the TransactionContextEx object has returned from a call in which it called the Abort method, a new transaction is started.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, SetAbort


ITransactionContext.Abort, ITransactionContext.Commit Methods Example

import com.ms.mtx.*;

ITransactionContextEx myTransactionContext = null;

IMyObject myObject = null;

boolean userCanceled = false;

// Get TransactionContextEx.

myTransactionContext = new TransactionContextEx();

// Create an instance of MyObject.

myObject = myTransactionContext.CreateInstance (CMyObject.clsid, IMyObject.iid);

// Do some work here.

// If something goes wrong, abort the transaction.

if (userCanceled)

myTransactionContext.Abort();

// Otherwise, commit it.

else

pTransactionContext.Commit();


ITransactionContextEx.Commit Method

Attempts to commit the current transaction.

Provided By

ITransactionContextEx Interface

void Commit ( );

Remarks

Calling Commit doesn't guarantee that a transaction will be committed. If any MTS object that was part of the transaction has returned from a method after calling SetAbort, the transaction will be aborted. If any object that was part of the transaction has called DisableCommit and hasn't yet called EnableCommit or SetComplete, the transaction will also be aborted. Any error that causes Microsoft Distributed Transaction Coordinator to abort a transaction will also abort an MTS transaction.

When a base client calls Commit, regardless of whether the transaction commits or aborts, the transaction is completed on return from this method and all objects that participated in the transaction are automatically deactivated. If another call comes in after the TransactionContextEx object has returned from a call in which it called the Commit method, a new transaction is started.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, SetComplete


ITransactionContextEx.CreateInstance Method

Instantiates an MTS object that will execute within the scope of the transaction that was initiated with the creation of the TransactionContextEx object.

Provided By

ITransactionContextEx Interface

IUnknown CreateInstance (

_Guid clsid,

_Guid  iid,

);

Parameter

clsid
[in] A reference to the CLSID of the type of object to instantiate.

iid
[in] Any interface that's implemented by the object you want to instantiate.

Return Value

A reference to the IUnknown interface on a new instance of the MTS component specified in the clsid parameter.

Remarks

When a base client uses the ITransactionContextEx.CreateInstance method to instantiate an MTS object, the new object executes within the transaction context object's activity. If the transaction attribute of the new object's component is set to either Supports transactions or Requires a transaction, the new object also inherits the transaction initiated with the creation of the TransactionContextEx object. However, if the component that provides the new object has its transaction attribute set to Does not support transactions, the object neither inherits the transaction nor passes it on to objects it subsequently creates. If the component that provides the new object has its transaction attribute set to Requires a new transaction, the MTS run-time environment initiates a new transaction for the new object, and that transaction is the one that's inherited by objects it subsequently creates.

CreateInstance always returns the IUnknown interface on the newly instantiated object. You should immediately cast the returned value to the interface with which you want to communicate with the new object. The interface ID you pass in the iid parameter doesn't have to be the same interface to which you cast the returned value, but it must be an interface that's implemented by the object you want to instantiate.

MTS always uses standard marshaling. Even if a component exposes the IMarshal interface, its IMarshal methods will never be called by the MTS run-time environment.

Note   You can't create MTS objects as part of an aggregation.

Example

See Also

Transaction Context Objects, Base Clients, Transactions, CreateInstance


ITransactionContext.CreateInstance Method Example

import com.ms.mtx.*;

ITransactionContextEx myTransactionContext = null;

IMyObject myObject = null;

// Get TransactionContextEx.

myTransactionContext = new TransactionContextEx();

// Create an instance of MyObject.

myObject = (IMyObject)

myTransactionContext.CreateInstance

(CMyObject.clsid, IMyObject.iid);


SecurityProperty Object

The SecurityProperty object is used to determine the current object's caller or creator.

Remarks

To use the SecurityProperty object, you must set a reference to Microsoft Transaction Server Type Library (mtxas.dll).

You obtain a reference to an object's SecurityProperty object by calling Security on the object's ObjectContext. For example:

Set secObject = ctxObject.Security

The SecurityProperty object provides the following methods.

Method	Description
GetDirectCallerName	Retrieves the user name associated with the external process that called the currently executing method.
GetDirectCreatorName	Retrieves the user name associated with the external process that directly created the current object.
GetOriginalCallerName	Retrieves the user name associated with the base process that initiated the call sequence from which the current method was called.
GetOriginalCreatorName	Retrieves the user name associated with the base process that initiated the activity in which the current object is executing.
See Also

Programmatic Security, Advanced Security Methods, ObjectContext Object


GetDirectCallerName Method

Retrieves the user name associated with the external process that called the currently executing method.

Applies To

SecurityProperty Object

Syntax

username = securityproperty.GetDirectCallerName( )

Part

username
The user name associated with the process from which the current method was invoked.

securityproperty
An object variable that evaluates to a SecurityProperty object.

Remarks

You use the GetDirectCallerName method to determine the user name associated with the process that called the object's currently executing method. The following scenarios illustrate the functionality of the GetDirectCallerName method.

A base process running on server A, as user A, calls into object X on server B, running as user B. Then object X calls into object Y, running on server C. If object Y calls GetDirectCallerName, the name of user B is returned.

Security can only be enforced across process boundaries. This means that the name returned by GetDirectCallerName is the name associated with the process that called into the process in which the current object is running, not necessarily the immediate caller into the object itself. If an object calls into another object within the same process, when the second object calls GetDirectCallerName, it will get the name of the most immediate caller outside its own process boundary, not the name of the object that directly called into it.

A base process, running on server A as user A, calls into object X on server B, running as user B. Then object X calls into object Y, running in the same process as object X, also on server B. When object Y calls GetDirectCallerName, the name of user A is returned , not the name of user B.

Example

See Also

Programmatic Security, Advanced Security Methods, ObjectContext Object


GetDirectCallerName Method Example

Public Function ComponentDirectCaller() As String

    Dim objCtx As ObjectContext

    Set objCtx = GetObjectContext()

    ComponentDirectCaller = _

        objCtx.Security.GetDirectCallerName()

End Function


GetDirectCreatorName Method

Retrieves the user name associated with the current object's immediate (out-of-process) creator.

Applies To

SecurityProperty Object

Syntax

username = securityproperty.GetDirectCreatorName( )

Part

username
The user name associated with the process that directly created the current object.

securityproperty
An object variable that evaluates to a SecurityProperty object.

Remarks

You use the GetDirectCreatorName method to determine the user name associated with the process that created the current object. The following scenarios illustrate the functionality of the GetDirectCreatorName method.

A base process running on server A, as user A, creates object X on server B, running as user B. Then object X creates object Y, running on server C. If object Y calls GetDirectCreatorName, the name of user B is returned.

Security can only be enforced across process boundaries. This means that if an object creates another object within the same process, when the second object calls GetDirectCreatorName, it will get the name of the most immediate creator outside its own process boundary, not the user name associated with the object that actually created it.

A base client running on server A, as user A, creates object X on server B, running as user B. Then object X creates object Y, running in the same process as object X, also on server B. When object Y calls GetDirectCreatorName, the name of user A is returned, not the name of user B.

Example

See Also

Programmatic Security, Advanced Security Methods, ObjectContext Object


GetDirectCreatorName Method Example

Public Function ComponentDirectCreator() As String

    Dim objCtx As ObjectContext

    Set objCtx = GetObjectContext()

    ComponentDirectCreator = _

        objCtx.Security.GetDirectCreatorName()

End Function


GetOriginalCallerName Method

Retrieves the user name associated with the base process that initiated the sequence of calls from which the call into the current object originated.

Applies To

SecurityProperty Object

Syntax

username = securityproperty.GetOriginalCallerName( )

Part

username
The user name associated with the base process that initiated the call sequence from which the current method was called.

securityproperty
An object variable that evaluates to a SecurityProperty object.

Remarks

You use the GetOriginalCallerName method to determine the user name associated with the original process that initiated the call sequence from which the current method was called. The following scenario illustrates the functionality of the GetOriginalCallerName method.

Base process 1, running on server A as user A, creates object X on server B, running as user B. Then base process 1 passes its reference on object X to base process 2, running on server D as user D. Base process 2 uses that reference to call into object X. object X then calls into object Y, running on server C. If object Y then calls GetOriginalCallerName, the name of user D is returned.

Note   Usually, an object's original caller is the same process as its original creator. The only situation in which the original caller and the original creator would be different is one in which the original creator passes a reference to another process, and the other process initiates the call sequence (as in the preceding example).

Note   The path to the original caller is broken if any object along the chain was created by some other means than IObjectContext::CreateInstance or ITransactionContext::CreateInstance. For example, if base process 1 uses CoCreateInstance to create X, when Y calls GetOriginalCallerName, the name it gets back will be the name of user B, not user D. This is because the call sequence is traced back through the objects' context and MTS can only create a context for an object that's created with either IObjectContext::CreateInstance or ITransactionContext::CreateInstance.

Example

See Also

Programmatic Security, Advanced Security Methods, ObjectContext Object


GetOriginalCallerName Method Example

Public Function ComponentOriginalCaller() As String

    Dim objCtx As ObjectContext

    Set objCtx = GetObjectContext()

    ComponentOriginalCaller = _

        objCtx.Security.GetOriginalCallerName()

End Function


GetOriginalCreatorName Method

Retrieves the user name associated with the original base process that initiated the activity in which the current object is executing.

Applies To

SecurityProperty Object

Syntax

username = securityproperty.GetOriginalCreatorName( )

Part

username
The user name associated with the base process that initiated the activity in which the current object is executing.

securityproperty
An object variable that evaluates to a SecurityProperty object.

Remarks

You use the GetOriginalCreatorName method to determine the user name associated with the process that initiated the activity in which the current object is executing. The following scenario illustrates the functionality of the GetOriginalCreatorName method.

A base process running on server A, as user A, creates object X on server B, running as user B. Then object X creates object Y, running on server C. If object Y calls GetOriginalCreatorName, the name of user A is returned.

Note   The path to the original creator is broken if an object is created by some other means than IObjectContext::CreateInstance or ITransactionContext::CreateInstance. For example, if the base process on server A uses CoCreateInstance to create X, when Y calls GetOriginalCreatorName, the name it gets back will be the name of user B, not user A. This is because the creation sequence is traced back through the objects' context and MTS can only create a context for an object that's created with either IObjectContext::CreateInstance or ITransactionContext::CreateInstance.

Example

See Also

Programmatic Security, Advanced Security Methods, ObjectContext Object


GetOriginalCreatorName Method Example

Public Function ComponentOriginalCreator() As String

    Dim objCtx As ObjectContext

    Set objCtx = GetObjectContext()

    ComponentOriginalCreator = _

        objCtx.Security.GetOriginalCreatorName()

End Function


ISecurityProperty Interface

The ISecurityProperty interface is used to determine the security ID of the current object's caller or creator.

Remarks

The header file for the ISecurityProperty interface is mtx.h. You must also link mtxguid.lib to your project to use this interface.

You obtain a reference to an object's ISecurityProperty interface by calling QueryInterface on the object's ObjectContext. For example:

m_pIObjectContext->QueryInterface (IID_ISecurityProperty, (void**)&m_pISecurityProperty);

The ISecurityProperty interface provides the following methods.

Method	Description
GetDirectCallerSID	Retrieves the security ID of the external process that called the currently executing method.
GetDirectCreatorSID	Retrieves the security ID of the external process that directly created the current object.
GetOriginalCallerSID	Retrieves the security ID of the base process that initiated the call sequence from which the current method was called.
GetOriginalCreatorSID	Retrieves the security ID of the base process that initiated the activity in which the current object is executing.
ReleaseSID	Releases the security ID returned by one of the other ISecurityProperty methods.
See Also

Programmatic Security, Advanced Security Methods, IObjectContext Interface


ISecurityProperty::GetDirectCallerSID Method

Retrieves the security ID of the external process that called the currently executing method.

Provided By

ISecurityProperty Interface

HRESULT ISecurityProperty::GetDirectCallerSID (

PSID* ppSid

);

Parameters

ppSid
[out] A reference to the security ID of the process from which the current method was invoked.

Return Values

S_OK
The security ID of the process that called the current method is returned in the parameter ppSid.

E_INVALIDARG
The argument passed in the ppSid parameter is a NULL pointer.

E_UNEXPECTED
An unexpected error occurred.

Remarks

You use the GetDirectCallerSID method to determine the security ID of the process that called the object's currently executing method. The following scenarios illustrate the functionality of the GetDirectCallerSID method.

A base process running on server A, as user A, calls into object X on server B, running as user B. Then object X calls into object Y, running on server C. If object Y calls GetDirectCallerSID, the the security ID of user B is returned.

Security can only be enforced across process boundaries. This means that the the security ID returned by GetDirectCallerSID is the the security ID associated with the process that called into the process in which the current object is running, not necessarily the immediate caller into the object itself. If an object calls into another object within the same process, when the second object calls GetDirectCallerSID, it will get the the security ID of the most immediate caller outside its own process boundary, not the the security ID of the object that directly called into it.

A base process, running on server A as user A, calls into object X on server B, running as user B. Then object X calls into object Y, running in the same process as object X, also on server B. When object Y calls GetDirectCallerSID, the the security ID of user A is returned , not the the security ID of user B.

You must call ReleaseSID on a security ID when you finish using it.

Example

See Also

Programmatic Security, Advanced Security Methods, IObjectContext Interface


GetDirectCallerSID Method Example

#include <mtx.h>

IObjectContext* pIObjectContext = NULL;

ISecurityProperty* pISecurityProperty = NULL;

PSID pSid = NULL;

HRESULT hr;

// Get a reference to the ISecurityProperty interface.

pIObjectContext->QueryInterface(IID_ISecurityProperty,

(void**)&pISecurityProperty);

// Obtain the caller's security ID.

hr = pISecurityProperty->GetDirectCallerSID(&pSid)

//	Do some security checking here.

// Release the security ID.

pISecurityProperty->ReleaseSID(pSid);


ISecurityProperty::GetDirectCreatorSID Method

Retrieves the security ID of the current object's immediate (out-of-process) creator.

Provided By

ISecurityProperty Interface

HRESULT ISecurityProperty::GetDirectCreatorSID (

PSID* ppSid

);

Parameters

ppSid
[out] A reference to the security ID of the process that directly created the current object.

Return Values

S_OK
The security ID of the process that directly created the current object is returned in the parameter ppSid.

E_INVALIDARG
The argument passed in the ppSid parameter is a NULL pointer.

E_FAIL
An unexpected error occurred.

Remarks

You use the GetDirectCreatorSID method to determine the security ID of the process that created the current object. The following scenarios illustrate the functionality of the GetDirectCreatorSID method.

A base process running on server A, as user A, creates object X on server B, running as user B. Then object X creates object Y, running on server C. If object Y calls GetDirectCreatorSID, the the security ID of user B is returned.

Security can only be enforced across process boundaries. This means that if an object creates another object within the same process, when the second object calls GetDirectCreatorSID, it will get the the security ID of the most immediate creator outside its own process boundary, not the security ID of the object that actually created it.

A base client running on server A, as user A, creates object X on server B, running as user B. Then object X creates object Y, running in the same process as object X, also on server B. When object Y calls GetDirectCreatorSID, the the security ID of user A is returned, not the the security ID of user B.

You must call ReleaseSID on a security ID when you finish using it.

Example

See Also

Programmatic Security, Advanced Security Methods, IObjectContext Interface


GetDirectCreatorSID Method Example

#include <mtx.h>

IObjectContext* pIObjectContext = NULL;

ISecurityProperty* pISecurityProperty = NULL;

PSID pSid = NULL;

HRESULT hr;

// Get a reference to the ISecurityProperty interface.

pIObjectContext->QueryInterface(IID_ISecurityProperty,

(void**)&pISecurityProperty);

// Obtain the creator's security ID.

hr = pISecurityProperty->GetDirectCreatorSID(&pSid)

// Do some security checking here.

// Release the security ID.

pISecurityProperty->ReleaseSID(pSid);


ISecurityProperty::GetOriginalCallerSID Method

Retrieves the security ID of the base process that initiated the sequence of calls from which the call into the current object originated.

Provided By

ISecurityProperty Interface

HRESULT ISecurityProperty::GetOriginalCallerSID (

PSID* ppSid

);

Parameters

ppSid
[out] A reference to the security ID of the base process that initiated the call sequence from which the current method was called.

Return Values

S_OK
The security ID of the base process that originated the call into the current object is returned in the parameter ppSid.

E_INVALIDARG
The argument passed in the ppSid parameter is a NULL pointer.

E_FAIL
An unexpected error occurred.

Remarks

You use the GetOriginalCallerSID method to determine the security ID of the original process that initiated the call sequence from which the current method was called. The following scenario illustrates the functionality of the GetOriginalCallerSID method.

Base process 1, running on server A as user A, creates object X on server B, running as user B. Then base process 1 passes its reference on object X to base process 2, running on server D as user D. Base process 2 uses that reference to call into object X. object X then calls into object Y, running on server C. If object Y then calls GetOriginalCallerSID, the the security ID of user D is returned.

Note   Usually, an object's original caller is the same process as its original creator. The only situation in which the original caller and the original creator would be different is one in which the original creator passes a reference to another process, and the other process initiates the call sequence (as in the preceding example).

Note   The path to the original caller is broken if any object along the chain was created by some other means than IObjectContext::CreateInstance or ITransactionContext::CreateInstance. For example, if base process 1 uses CoCreateInstance to create X, when Y calls GetOriginalCallerSID, the the security ID it gets back will be the the security ID of user B, not user D. This is because the call sequence is traced back through the objects' context and MTS can only create a context for an object that's created with either IObjectContext::CreateInstance or ITransactionContext::CreateInstance.

You must call ReleaseSID on a security ID when you finish using it.

Example

See Also

Programmatic Security, Advanced Security Methods, IObjectContext Interface


GetOriginalCallerSID Method Example

#include <mtx.h>

IObjectContext* pIObjectContext = NULL;

ISecurityProperty* pISecurityProperty = NULL;

PSID pSid = NULL;

HRESULT hr;

// Get a reference to the ISecurityProperty interface.

pIObjectContext->QueryInterface(IID_ISecurityProperty,

(void**)&pISecurityProperty);

// Obtain the original caller's security ID.

hr = pISecurityProp->GetOriginalCallerSID(&pSid)

// Do some security checking here.

// Release the security ID.

pISecurityProperty->ReleaseSID(pSid);


ISecurityProperty::GetOriginalCreatorSID Method

Retrieves the security ID of the original base process that initiated the activity in which the current object is executing.

Provided By

ISecurityProperty Interface

HRESULT ISecurityProperty::GetOriginalCreatorSID (

PSID* ppSid

);

Parameters

ppSid
[out] A reference to the security ID of the base process that initiated the activity in which the current object is executing.

Return Values

S_OK
The security ID of the original creator is returned in the parameter ppSid.

E_INVALIDARG
The argument passed in the ppSid parameter is a NULL pointer.

E_FAIL
An unexpected error occurred.

Remarks

You use the GetOriginalCreatorSID method to determine the security ID of the process that initiated the activity in which the current object is executing. The following scenario illustrates the functionality of the GetOriginalCreatorSID method.

A base process running on server A, as user A, creates object X on server B, running as user B. Then object X creates object Y, running on server C. If object Y calls GetOriginalCreatorSID, the the security ID of user A is returned.

Note   The path to the original creator is broken if an object is created by some other means than IObjectContext::CreateInstance or ITransactionContext::CreateInstance. For example, if the base process on server A uses CoCreateInstance to create X, when Y calls GetOriginalCreatorSID, the the security ID it gets back will be the the security ID of user B, not user A. This is because the creation sequence is traced back through the objects' context and MTS can only create a context for an object that's created with either IObjectContext::CreateInstance or ITransactionContext::CreateInstance.

You must call ReleaseSID on a security ID when you finish using it.

Example

See Also

Programmatic Security, Advanced Security Methods, IObjectContext Interface


GetOriginalCreatorSID, ReleaseSID Methods Example

#include <mtx.h>

IObjectContext* pIObjectContext = NULL;

ISecurityProperty* pISecurityProperty = NULL;

PSID pSid = NULL;

HRESULT hr;

// Get a reference to the ISecurityProperty interface.

pIObjectContext->QueryInterface(IID_ISecurityProperty,

(void**)&pISecurityProperty);

// Obtain the original creator's security ID.

hr = pISecurityProp->GetOriginalCreatorSID(&pSid)

// Do some security checking here.

// Release the security ID.

pISecurityProperty->ReleaseSID(pSid);


ISecurityProperty::ReleaseSID Method

Releases a security ID that was obtained from the GetDirectCallerSID, GetDirectCreatorSID, GetOriginalCallerSID, or GetOriginalCreatorSID method.

Provided By

ISecurityProperty Interface

HRESULT ISecurityProperty::ReleaseSID (

PSID pSid

);

Parameters

pSid
[in] A reference to a security ID that was obtained by invoking one of the ISecurityProperty methods.

Return Values

S_OK
The security ID, passed in the pSid parameter, was released.

E_INVALIDARG
The argument passed in the pSid parameter is not a reference to a security ID.

Remarks

You should always invoke the ReleaseSID method to release any security ID pointers returned by the GetDirectCallerSID, GetDirectCreatorSID, GetOriginalCallerSID, and GetOriginalCreatorSID methods of the ISecurityProperty interface.

See Also

Programmatic Security, Advanced Security Methods, IObjectContext Interface


MTS Error Codes

The following errors can be returned by Microsoft Transaction Server (MTS) objects.

S_OK
The call succeeded.

E_INVALIDARG
One or more of the arguments passed in is invalid.

E_UNEXPECTED
An unexpected error occurred.

CONTEXT_E_NOCONTEXT
The current object doesn't have a context associated with it. This is probably either because its component hasn't been installed in a package or it wasn't created with one of the MTS CreateInstance methods.

CONTEXT_E_ROLENOTFOUND
The role specified in the szRole parameter in the IObjectContext::IsCallerInRole method does not exist.

E_OUTOFMEMORY
There's not enough memory available to instantiate the object. This error code can be returned by IObjectContext::CreateInstance or ITransactionContext::CreateInstance.

REGDB_E_CLASSNOTREG
The specified component is not registered as a COM component. This error code can be returned by IObjectContext::CreateInstance or ITransactionContext::CreateInstance.

DISP_E_ARRAYISLOCKED
One or more of the arguments passed in contains an array that is locked. This error code can be returned by the ISharedProperty::put_Value method.

DISP_E_BADVARTYPE
One or more of the arguments passed in isn't a valid VARIANT type. This error code can be returned by the ISharedProperty::put_Value method.


MTS Supported Variant Types

The following Automation types are supported by Microsoft Transaction Server.

VT_BOOL	VT_LPSTR
VT_BSTR	VT_LPWSTR
VT_CARRAY	VT_NULL
VT_CLSID	VT_PTR
VT_CY	VT_R4
VT_DATE	VT_R8
VT_DECIMAL	VT_SAFEARRAY
VT_DISPATCH	VT_UINT
VT_EMPTY	VT_UI1
VT_ERROR	VT_UI2
VT_HRESULT	VT_UI4
VT_INT	VT_UI8
VT_I1	VT_UNKNOWN
VT_I2	VT_USERDEFINED
VT_I4	VT_VARIANT
VT_I8	VT_VOID
The following types are not supported and will cause the server process to terminate with an error.

VT_FILETIME	VT_BLOB
VT_STREAM	VT_STORAGE
VT_STREAMED_OBJECT	VT_STORED_OBJECT
VT_BLOB_OBJECT	VT_CF


MTS Administrative Reference

The Microsoft Transaction Server (MTS) Administrative reference provides object and method information for Microsoft® Visual Basic or Microsoft Visual Basic Scripting Edition (VBScript) programmers, and interface and function information for Microsoft Visual C++® programmers. In addition, this technical reference provides a detailed description of the collections used by the administration objects.

This section contains the following sections:

Using MTS Administration Objects

Using MTS Collection Types

Automating MTS Administration With Visual Basic

MTS Administration Object Methods

Automating MTS Administration With Visual C++

See Also

Automating MTS Administration


Automating MTS Administration With Visual Basic

This reference topic provides guidance for Microsoft® Visual Basic or Microsoft Visual Basic Scripting Edition (VBScript) programmers who want to use the administration objects to automate tasks that an administrator performs using the Microsoft Transaction Server (MTS) Explorer. The MTS Visual Basic reference contains the following topics:

MTS Visual Basic Error Codes

MTS Administration Object Methods

See Also

Automating MTS Administration


Using MTS Administration Objects

Use the MTS administration objects to automate administration for MTS packages.

This section describes how the following administration objects are used:

MTS Catalog Object

MTS CatalogObject Object

MTS CatalogCollection Object

MTS PackageUtil Object

MTS ComponentUtil Object

MTS RemoteComponentUtil Object

MTS RoleAssociationUtil Object


MTS Catalog Object

The Catalog object enables you to connect to an MTS catalog and access collections. This general administration object supports the following methods.

Method	Description
GetCollection	Gets a collection on the catalog without reading any objects from the catalog.
Connect	Connects to a remote catalog and returns a root collection.
MajorVersion	Returns the major version number of the catalog.
MinorVersion	Returns the minor version number of the catalog.
See Also

MTS CatalogObject Object, MTS CatalogCollection Object, MTS PackageUtil Object, MTS ComponentUtil Object, MTS RemoteComponentUtil Object, MTS RoleAssociationUtil Object


MTS CatalogObject Object

The CatalogObject object allows you to get and set object properties. This general administration interface supports the following methods.

Method	Description
Value	Gets and sets a property value
Key	Gets the value of the key property
Name	Gets the name of the object
IsPropertyReadOnly	True if the property cannot be set
IsPropertyWriteOnly	True if the property only supports set
Valid	True if all properties were successfully read from the catalog data store
See Also

MTS Catalog Object, MTS CatalogCollection Object, MTS PackageUtil Object, MTS ComponentUtil Object, MTS RemoteComponentUtil Object, MTS RoleAssociationUtil Object


MTS CatalogCollection Object

Use the CatalogCollection object to enumerate, add, delete, and modify catalog objects and to access related collections This general administration interface supports the following methods.

Method	Description
Item	Returns an object by index. The index is zero-based.
Count	Returns number of objects in the collection.
Remove	Removes an item according to its index position.
Add	Adds an object to the collection.
Populate	Reads all the collection objects from the catalog data store.
SaveChanges	Saves changes made to the collection into the catalog data store.
GetCollection	Gets a collection related to a specific object.
Name	Gets the name of a collection.
AddEnabled	Returns true if the Add method is enabled.
RemoveEnabled	Returns true if the Remove method is enabled.
GetUtilInterface	Gets the utility interface for the collection.
PopulateByKey	Reads the selected collection objects from the catalog data store.
DataStoreMajorVersion	Returns the major version number of the catalog data store.
DataStoreMinorVersion	Returns the minor version number of the catalog data store.
See Also

Add Method (CatalogCollection), Remove Method (CatalogCollection), MTS Catalog Object, MTS CatalogObject Object, MTS PackageUtil Object, MTS ComponentUtil Object, MTS RemoteComponentUtil Object, MTS RoleAssociationUtil Object


MTS PackageUtil Object

The PackageUtil object enables installing and exporting a package. Instantiate this object by calling GetUtilInterface on a Packages collection.

This utility administration interface supports the following methods:

Method	Description
InstallPackage	Installs a pre-built package.
ExportPackage	Exports a package.
ShutdownPackage	Shuts down a package, thereby terminating that server process.
See Also

MTS Catalog Object, MTS CatalogObject Object, MTS CatalogCollection Object, MTS ComponentUtil Object, MTS RemoteComponentUtil Object, MTS RoleAssociationUtil Object


MTS ComponentUtil Object

Call the ComponentUtil object to install a component in a specific collection and import components registered as in-process servers. Create this object by calling GetUtilInterface on a ComponentsInPackage collection. This utility administration interface supports the following methods.

Method	Description
InstallComponent	Installs a component from a DLL.
ImportComponent	Imports a component that is already registered as an in-process server. Supply the CLSID of the component.
ImportComponentByName	Imports a component that is already registered as an in-process server. Supply the ProgID of the component.
GetCLSIDS	Returns an array of installable CLSIDs in the DLL/type library. Note that changes are not made to the data store.
See Also

MTS Catalog Object, MTS CatalogObject Object, MTS CatalogCollection Object, MTS PackageUtil Object, MTS RemoteComponentUtil Object, MTS RoleAssociationUtil Object


MTS RemoteComponentUtil Object

Using the RemoteComponentUtil object, you can program your application to pull remote components from a package on a remote server. Instantiate this object by calling GetUtilInterface on a RemoteComponents collection. This utility administration interface supports the following methods.

Method	Description
InstallRemoteComponent	Pulls remote components from a package on a remote server. Supply the package ID and CLSID.
InstallRemoteComponentByName	Pulls remote components from a package on a remote server. Supply the package name and ProgID.
See Also

GetUtilInterface Method (CatalogCollection), MTS Catalog Object, MTS CatalogObject Object, MTS CatalogCollection Object, MTS PackageUtil Object, MTS ComponentUtil Object, MTS RoleAssociationUtil Object


MTS RoleAssociationUtil Object

Call methods on the RoleAssociationUtil object to associate roles with a component or interface. Create this object by calling the GetUtilInterface method on a RolesForPackageComponent or RolesForPackageComponentInterface collection. This utility administration interface supports the following methods.

Method	Description
AssociateRole	Associates the role by role ID with the component or interface.
AssociateRoleByName	Associates the role by role name with the component or interface.
See Also

GetUtilInterface Method (CatalogCollection), MTS Catalog Object, MTS CatalogObject Object, MTS CatalogCollection Object, MTS PackageUtil Object, MTS ComponentUtil Object, MTS RemoteComponentUtil Object


Using MTS Collection Types

This topic describes the collections and collection properties supported by the MTS catalog. Additional collections and properties may be added in future versions. Use the DataStoreMajorVersion and DataStoreMinorVersion properties of a collection to distinguish between catalog versions.

The MTS catalog data store supports the following collection types:

MTS LocalComputer Collection

MTS ComputerList Collection

MTS Packages Collection

MTS ComponentsInPackage Collection

MTS RemoteComponents Collection

MTS InterfacesForComponent and InterfacesForRemoteComponent Collections

MTS RolesForPackageComponent and RolesForPackageComponentInterface Collections

MTS MethodsForInterface Collection

MTS RolesInPackage Collection

MTS UsersInRole Collection

MTS ErrorInfo Collection

MTS PropertyInfo Collection

MTS RelatedCollectionInfo Collection


MTS LocalComputer Collection

The LocalComputer contains a single object that corresponds to the computer whose catalog that you are accessing. If you call the Connect method on the Catalog object, the LocalComputer collection contains information about the computer whose catalog you are accessing. This collection does not support the Add, Remove or GetUtilInterface methods.

The following table provides a list of the properties supported by the LocalComputer collection.

Property	Description
Name	«My Computer». Data Type: String Default value: N/A Access: Read only.
Description	Description of the computer. Data Type: String Default value: Empty string Access: Read/write
Transaction Timeout	The transaction timeout setting in seconds. Data Type: Integer Default value: 60 Access: Read/write
RemoteComponent InstallPath	The path in which remote component files will be installed when remote components are configured Data Type: String Default value: the subdirectory «Remote» in the MTS install path  Access: Read/write
PackageInstall Path	The default path in which component files will be installed when pre-built packages are installed. Data Type: String Default value: the subdirectory «Packages» in the MTS install path  Access: Read/write
ResourcePooling Enabled	«Y» enables resource pooling. «N» disables resource pooling. Note that resource pooling is currently only supported by the ODBC resource dispenser.  Data Type: String Default value: «Y»  Access: Read/write
ReplicationShare	When replicating the MTS catalog, the name of a share that the target system should use to access installed packages.  Data Type: String Default value: Empty string Access: Read/write
RemoteServer Name	The computer name to be generated when you use the MTS Explorer to create a client executable. If this string is blank or empty, the physical computer name of the exporting computer is used. If you put the name of the remote server as the string, the application executable generated by the MTS Explorer points to that remote server name. Data Type: String Default value: Empty string Access: Read/write
See Also

RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS ComputerList Collection

The ComputerList collection provides access to the list of computers shown in the MTS Explorer Computers folder. This collection supports the  Add and Remove methods. This collection does not support the GetUtilInterface method.

The following table provides a list of the properties supported by the ComputerList collection.

Property	Description
Name	The name of the computer. Data Type: String Default value: «NewComputer» Access: Read/Write while using the Add method. After adding, read-only.
See Also

RelatedCollectionInfo, PropertyInfo, ErrorInfo, Add Method (CatalogCollection), Remove Method (CatalogCollection)


MTS Packages Collection

As the top-level collection managed by the MTS Explorer, the Packages collection contains the packages installed on the local machine running MTS. Packages contain a set of components that run in the same server process, and define declarative security constructs that determine access to components at run time. The Packages collection supports the Add method and Remove method on the CatalogCollection object. In addition, the GetUtilInterface method of this collection returns a PackageUtil object which can be used to install and export packages.

The following table provides a list of the properties supported by the CatalogObject objects within the Packages collection.

Property	Description
Name	Name of the package. Data Type: String Default value: «New package» Access: Read/Write
ID	A universally unique identifier (UUID) for the package. Data Type: String Default value: A unique identifier is generated Access: Read/Write when using the Add method. Read-only  after using the Add method.
Description	Describes the package. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read/Write
IsSystem	Identifies an MTS system package. «N» signifies that the package is not a Transaction Server system package, and «Y» indicates that package is an MTS system package. Data Type: String Default value: «N» Access: Read only
Authentication	Sets authentication level for calls. Possible values are 0 through 6, which correspond to the Remote Procedure Call (RPC) authentication settings.  Data Type: Long Default value: 4 Access: Read/Write
ShutdownAfter	Sets the delay before shutting down a server process after it becomes idle. Shutdown latency ranges from 0 to 1440 minutes. Data Type: Long Default value: 3 Access: Read/Write
RunForever	Enables a server process to continue if a package is idle. If value is set to «Y», the server process will not shut down when left idle. If set to «N», the process will shut down according the value set by the ShutDownAfter property. Data Type: String Default value: «N» Access: Read/Write
SecurityEnabled	Checks the security credentials of any client that calls the package if value is set to «Y.» Data Type: String Default value: «N» Access: Read/Write
Identity	Sets the server process identity for the package. Specify a valid Windows NT user account or "Interactive User" to have the package assume the identity of the current logged-on user. Data Type: String Default value: «Interactive User» Access: Read/Write
Password	Sets the password used by the server process to log on under the identity above. Data Type: String Default value: None Access: Write only
Activation	Sets the package level activation property to either «Local» or «Inproc». The Local setting determines that objects within the package will run within a dedicated local server process. A package running under the Local activation setting is a «server package». The Inproc activation setting means objects run in their creator’s process. A package running under the Inproc activation setting is a «library package» Data Type:  String Default Value: «Local» Access:  Read/Write
Changeable	Sets whether changes to the package settings, or those of its components, are allowed (either programmatically, or through the MTS UI).
	Data Type:  String Default Value:  Y Access:  Read/Write
Deleteable	Sets whether the package or its components can be deleted (either programmatically, or through the MTS UI). Data Type:  String Default Value: «Y» Access:  Read/Write
CreatedBy	Informational string to describe the package creator. Data Type:   String Default Value: Empty string Access:  Read/Write
See Also

ComponentsInPackage, RolesInPackage, RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS ComponentsInPackage Collection

The ComponentsInPackage collection contains the set of components that run in the same server process and compose a package. This collection supports the Remove method. The Add method is not supported. You must use the ComponentUtil object to install components into the package.

The following table provides a list of the properties supported by the CatalogObjects within the ComponentsInPackage collection.

Property	Description
ProgID	The name that identifies the component. Data Type: String Default value: None Access: Read only
CLSID	The universally unique identifier (UUID) for the component. Data Type: String Default value: None Access: Read only
Transaction	Determines how a component supports transactions. Must be one of the following transaction settings: «Required» «Requires New» «Not Supported» «Supported» Data Type: String Default value: «Not supported» Access: Read/Write
Description	Describes the component. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read/Write
PackageID	Defines the identity of the owning package. Data Type: String Default value: None Access: Read only
PackageName	Defines the name of the owning package. Data Type: String Default value: «New Package» Access: Read only
ThreadingModel	Determines how instances of the component are assigned to threads for method execution. Possible values are those supported by Component Object Model (COM). Data Type: String Default value: None Access: Read only
SecurityEnabled	Checks the security credentials of any client that calls the component if value is set to «Y.» Data Type: String Default value: «Y» Access: Read/Write
DLL	Displays the name of the DLL containing the component implementation. Data Type: String Default value: None Access: Read only
IsSystem	Identifies an MTS system component. «N» signifies that the package is not a Transaction Server system component, and «Y» indicates that package is an MTS system component. Data Type: String Default value: «N» Access: Read only
See Also

InterfacesForComponent, RolesForPackageComponent, RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS RemoteComponents Collection

Use the Microsoft Transaction Server (MTS) Explorer on a client computer to add remote component entries that see components installed on a remote server. This is often described as "pulling" remote component information from a server. Configuring remote components automatically copies proxy/stub DLLs and type libraries from the server to the client. The RemoteComponents collection supports the Remove method. This collection does not support the Add method on the CatalogCollection object. Instead you must call GetUtilInterface to obtain the RemoteComponentUtil object in order to add new remote components.

The following table provides a list of the properties supported by the CatalogObjects within the RemoteComponents collection.

Property	Description
ProgID	The name that identifies the remote component. Data Type: String Default value: None Access: Read only
CLSID	The universally unique identifier (UUID) for the component. Data Type: String Default value: None Access: Read only
Description	Describes the remote component. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read/Write
Server	Name of the server hosting the remote component. Data Type: String Default value: None Access: Read only
See Also

InterfacesForRemoteComponent, RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS InterfacesForComponent and InterfacesForRemoteComponent Collections

The InterfacesForComponent and InterfacesForRemoteComponent collections provide information about a selected interface. InterfacesForComponent or InterfacesForRemoteComponent collections are listed for each component, and can be used by an administrator to identify or manage the interface. These collections do not support the Add, Remove, or GetUtilInterface methods.

The following table provides a list of the properties supported by the CatalogObjects within the InterfacesForComponent and the InterfacesForRemoteComponent collections.

Property	Description
Name	Displays the friendly name of the interface. Data Type: String Default value: None Access: Read only
ID	Displays the unique interface identifier (IID).  Data Type: String Default value: None Access: Read only
Description	Describes the interface. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read/Write
ProxyCLSID	Displays the CLSID of the proxy/stub.  Data Type: String Default value: None Access: Read only
ProxyDLL	Displays the file name of the proxy/stub DLL. Data Type: String Default value: None Access: Read only
ProxyThreadingModel	Displays the threading model of the selected proxy/stub. Data Type: String Default value: None Access: Read only
TypeLibID	Displays the UUID of the type library. Data Type: String Default value: None Access: Read only
TypeLibVersion	Displays the version of the type library. Data Type: String Default value: None Access: Read only
TypeLibLangID	Displays the language identification number of the type library. Data Type: String Default value: None Access: Read only
TypeLibPlatform	Displays the platform of the type library. Data Type: String Default value: None Access: Read only
TypeLibFile	Displays the file name of the type library. Data Type: String Default value: None Access: Read only
See Also

MethodsForInterface (InterfacesForComponent only), RolesForPackageComponentInterface (InterfacesForComponent only), RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS RolesForPackageComponent and RolesForPackageComponentInterface Collections

The RoleForPackageComponent and RolesForPackageComponentInterface collections contain the roles associated with a component or interface. You add existing roles to these collections from a package's RolesInPackage collection. The Add method is not supported by this collection. Use the RoleAssociationUtil methods to add roles to this collection. The CatalogCollection Remove method is supported by this collection.

The following table provides a list of the properties supported by the CatalogObject(s) within the RolesForPackageComponent and the RolesForPackageComponentInterface collections.

Property	Description
Name	Displays the name of the role associated with a component. Data Type: String Default value: None Access: Read only
ID	Displays the universally unique identifier (UUID) of the role. Data Type: String Default value: None Access: Read only
Description	Describes the role. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read only
See Also

RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS MethodsForInterface Collection

The MethodsForInterface collection contains the methods defined in an interface. Method properties are used to display information about the methods exposed by an interface. This collection does not support the Add, Remove, or GetUtilInterface methods.

The following table provides a list of the properties supported by the CatalogObjects within the MethodsForInterface collection.

Property	Description
Name	Displays the name of a method. Data Type: String Default value: None Access: Read only
Description	Describes the method. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read only
See Also

RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS RolesInPackage Collection

The RolesInPackage collection defines a class of users for a set of components in a package. Each role defines a set of users allowed to invoke interfaces on a component. Roles can be applied to both components and component interfaces. This collection supports the Add and Remove methods. This collection does not support the GetUtilInterface method.

The following table provides a list of the properties supported by the CatalogObjects within the RolesInPackage collection.

Property	Description
Name	The role name. Data Type: String Default value: «New Role» Access: Read/write
ID	The universally unique identifier (UUID) for the role. Data Type: String Default value: A unique identifier is generated. Access: Read/Write while using the Add method. After adding an object, Read-only.
Description	Describes the new Role. Description fields hold a maximum of 500 characters. Data Type: String Default value: None Access: Read/write
See Also

UsersInRole, RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS UsersInRole Collection

The UsersInRole collection lists the members of the class of users that have been authorized to invoke methods on the component or component interface associated with the role. This collection supports the Add and Remove methods. This collection does not support the GetUtilInterface method.

The following table provides a list of the properties supported by the CatalogObjects within the UsersInRole collection.

Property	Description
User	The name of an NT user account or group. Data Type: String Default value: «New User» Access: Read/Write while using the Add method. After adding, read-only.
See Also

RelatedCollectionInfo, PropertyInfo, ErrorInfo


MTS ErrorInfo Collection

The ErrorInfo collection is used to retrieve extended error information about methods that deal with multiple objects. This collection does not support the Add, Remove, or GetUtilInterface methods. Use the GetCollection method on a collection to access the ErrorInfo collection associated with the original collection. The ErrorInfo collection is accessible from any collection except ErrorInfo, RelatedCollectionInfo, and PropertyInfo. When calling methods on a utility object, extended error information may be created in the ErrorInfo collection associated with the collection used to create the utility object.

The following table provides a list of the properties supported by the CatalogObjects within the ErrorInfo collection.

Property	Description
Name	Name of the object or file. Data Type: String Default value: None Access: Read only.
ErrorCode	Error code for the object or file. Data Type: Long Default value: None Access: Read only
See Also

MTS LocalComputer Collection, MTS ComputerList Collection, MTS Packages Collection, MTS ComponentsInPackage Collection, MTS RemoteComponents Collection, MTS InterfacesForComponent and InterfacesForRemoteComponent Collections, MTS RolesForPackageComponent and RolesForPackageComponentInterface Collections, MTS MethodsForInterface Collection, MTS RolesInPackage Collection, MTS UsersInRole Collection, MTS PropertyInfo Collection, MTS RelatedCollectionInfo Collection


MTS PropertyInfo Collection

The PropertyInfo collection is used to retrieve information about the properties that a specified collection supports. This collection does not support the Add, Remove, or GetUtilInterface methods. The PropertyInfo collection is accessible from any collection by using the GetCollection method.

The following table provides a list of the properties supported by the CatalogObject(s) within the PropertyInfo collection.

Property	Description
Name	Name of the property. Data Type: String Default value: None Access: Read only
See Also

MTS LocalComputer Collection, MTS ComputerList Collection, MTS Packages Collection, MTS ComponentsInPackage Collection, MTS RemoteComponents Collection, MTS InterfacesForComponent and InterfacesForRemoteComponent Collections, MTS RolesForPackageComponent and RolesForPackageComponentInterface Collections, MTS MethodsForInterface Collection, MTS RolesInPackage Collection, MTS UsersInRole Collection, MTS ErrorInfo Collection, MTS RelatedCollectionInfo Collection


MTS RelatedCollectionInfo Collection

The RelatedCollectionInfo collection is used to retrieve information about other collections related to the collection from which this collection is called. The RelatedCollectionInfo collection is accessible from any collection by using the GetCollection method. The RelatedCollectionInfo collection will contain one object for each collection that is accessible from the original collection. Related collections follow the MTS Explorer folder hierarchy. This collection does not support the Add, Remove, or GetUtilInterface methods.

The following table provides a list of the properties supported by the CatalogObjects within the RelatedCollectionInfo collection.

Property	Description
Name	Name of the related collection. Data Type: String Default value: None Access: Read only
See Also

MTS LocalComputer Collection, MTS ComputerList Collection, MTS Packages Collection, MTS ComponentsInPackage Collection, MTS RemoteComponents Collection, MTS InterfacesForComponent and InterfacesForRemoteComponent Collections, MTS RolesForPackageComponent and RolesForPackageComponentInterface Collections, MTS MethodsForInterface Collection, MTS RolesInPackage Collection, MTS UsersInRole Collection, MTS ErrorInfo Collection, MTS PropertyInfo Collection


MTS Visual Basic Error Codes

The following table lists the error codes returned by methods called on the MTS catalog collection and catalog utility objects.

Error code	Description
Visual Basic run-time error 5	Indicates one of the following: An invalid collection or property name was entered. An out parameter was NULL. The value is not one of the supported values or falls outside the supported range. The property is read-only. The property cannot be changed after the object is created. An invalid index was entered.
Visual Basic run-time  error 445	Object has been removed from the collection or the method is not supported on this object.
mtsErrObjectErrors	Errors were encountered processing some objects or file. See the ErrorInfo collection for object and file-specific error codes.
mtsErrNoUser	User ID for user in role is not valid.
mtsErrUserPasswdNotValid	Package identity user ID and/or password are not valid.
mtsErrAuthenicationLevel	Required authentication level (package privacy) could not be set for package updates.
mtsErrPDFReadFail	An error occurred reading the package file.
mtsErrPDFVersion	Package file version is invalid.
mtsErrBadPath	Package file path is invalid.
mtsErrPackageExists	Package with the same ID is already installed.
mtsErrRoleExists	A role with the same ID is already installed. The role ID in the package file is likely corrupted.
mtsErrCantCopyFile	Errors occurred copying one or more files to the install directory.
mtsErrInvalidUserids	One or more user IDS for roles were invalid.
mtsErrCLSIDOrIIDMismatch	One or more component or interface identifiers in a component DLL do not match the identifiers saved in the package file. The package file is out of date.
mtsErrPackDirNotFound	Package install directory is invalid due to general registry read/write errors.
mtsErrPDFWriteFail	An error occurred writing the package file.
mtsErrNoTypeLib	Could not find the type library for one or more components.
The following table lists the object or file-specific error codes returned in ErrorInfo collections.

Error code	Description
mtsErrObjectInvalid	One or more object properties is corrupted or invalid.
mtsErrKeyMissing	One or more objects is not found in the catalog data store.
mtsErrAlreadyInstalled	Component is already installed.
mtsErrDownloadFailed	One or more component files could not be copied to the client.
mtsErrRemoteInterface	No interface information is available for the component. Component files could not be downloaded.
mtsErrCoReqCompInstalled	Component in the same DLL file is already installed.
mtsErrNoRegistryCLSID	Component’s CLSID is corrupted.
mtsErrBadRegistryProgID	Component’s ProgID is corrupted.
mtsErrDllLoadFailed	Component’s DLL could not be loaded.
mtsErrDllRegisterServer	DllRegisterServer method failed during component self-registration.
mtsErrNoServerShare	No file share is available on the server to copy component files from the network path.
mtsErrNoAccessToUNC	Network path registered for this component could not be accessed.
mtsErrBadRegistryLibID	Component type library ID is corrupted.
mtsErrTreatAs	Component TreatAs key was found, but is not supported.
mtsErrBadForward	IID forward entry is corrupted.
mtsErrBadIID	IID is corrupted.
mtsErrRegistrarFailed	Component registrar method failed during component install.
mtsErrCompFileDoesNotExist	Component file does not exist.
mtsErrCompFileLoadDLLFail	DLL file could not be loaded.
mtsErrCompFileGetClassObj	DllGetClassObject function call failed during the DLL self-registration process.
mtsErrCompFileClassNotAvail	Class coded in the type library was not supported.
mtsErrCompFileBadTLB	Type library was corrupted.
mtsErrCompFileNotInstallable	File does not contain COM components or type library information.
mtsErrNotChangeable	Changes to this object and sub-objects have been disabled.
mtsErrNotDeletable	Delete function for this object has been disabled.
mtsErrSession	Catalog version is not supported.
The following tables lists general read and write registry errors.

Error Code	Description
mtsErrNoRegistryRead	Access control failure reading a registry key.
mtsErrNoRegistryWrite	Access control failure writing a registry key.
mtsErrNoRegistryRepair	Access control failure writing a registry key.


MTS Administration Object Methods

The following topics list the methods of the MTS administration objects:

Add Method (CatalogCollection)

AddEnabled Property (CatalogCollection)

AssociateRole Method (RoleAssociationUtil)

AssociateRoleByName Method (RoleAssociationUtil)

Connect Method (Catalog)

Count Property (CatalogCollection)

DataStoreMajorVersion Property (CatalogCollection)

DataStoreMinorVersion Property (CatalogCollection)

ExportPackage Method (PackageUtil)

GetCLSIDs Method (ComponentUtil)

GetCollection Method (Catalog)

GetCollection Method (CatalogCollection)

GetUtilInterface Method (CatalogCollection)

ImportComponent Method (ComponentUtil)

ImportComponentByName Method (ComponentUtil)

InstallComponent Method (ComponentUtil)

InstallPackage Method (PackageUtil)

InstallRemoteComponent Method (RemoteComponentUtil)

InstallRemoteComponentByName Method (RemoteComponentUtil)

IsPropertyReadOnly Property (CatalogObject)

IsPropertyWriteOnly Property (CatalogObject)

Item Property (CatalogCollection)

Key Property (CatalogObject)

MajorVersion Property (Catalog)

MinorVersion Property (Catalog)

Name Property (CatalogObject)

Name Property (CatalogCollection)

Populate Method (CatalogCollection)

PopulateByKey Method (CatalogCollection)

Remove Method (CatalogCollection)

RemoveEnabled Property (CatalogCollection)

SaveChanges Method (CatalogCollection)

ShutdownPackage Method

Valid Property (CatalogObject)

Value Property (CatalogObject)

See the Automating MTS Administration topic for sample code that demonstrates how these methods are used to program administration using Microsoft® Visual Basic or Microsoft Visual Basic Scripting Edition (VBScript).


Add Method (CatalogCollection)

Adds a member to a collection object and returns the CatalogObject object.

Syntax

object.Add

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

Call the Add method to create a new object in a collection. This method is supported in the following collections:

Packages

RolesInPackage

UsersInRole

To install or create objects in other collections, use the catalog utility interfaces. Note that you must call the SaveChanges method to write the new object to the catalog data store.

For a list of the MTS collections and their properties, see Using MTS Collections.

See Also

MTS Packages Collection, MTS RolesInPackage Collection, MTS UsersInRole Collection, AddEnabled Property (CatalogCollection)


AddEnabled Property (CatalogCollection)

Returns a Boolean value indicating whether the Add method is enabled on this collection.

Syntax

object.AddEnabled

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

If the value returned is True, then you can call the Add method to create a new object in a collection. If the value returned is False, you must use the catalog utility object methods to create a new object.

For a list of the MTS collections and their properties, see the Using MTS Collections topic.

See Also

Add Method (CatalogCollection)


AssociateRole Method (RoleAssociationUtil)

Associates a role with a component or component interface.

Syntax

object.AssociateRole(ID)

Parameters

object
Required. An object variable that evaluates to a RoleAssociationUtil object.

ID
Required. A String expression that specifies the role ID of the roles to associate with the object.

Remarks

The changes are applied immediately to the catalog.

For a list of properties supported by Role collections,see the Using MTS Collections topic.

See Also

AssociateRoleByName Method (RoleAssociationUtil)


AssociateRoleByName Method (RoleAssociationUtil)

The AssociateRoleByName method associates a role with a specified component or component interface.

Syntax

object.AssociateRoleByName(name)

Parameters

object
Required. An object variable that evaluates to a RoleAssociationUtil utility object.

name
Required; String. An expression providing the name of the role to associate with a component or component interface.

Remarks

The changes are applied immediately to the catalog. For a list of properties supported by Role collections,see the Using MTS Collections topic.

See Also

AssociateRole Method (RoleAssociationUtil)


Connect Method (Catalog)

Connects to a catalog and returns a root collection.

Syntax

set root object.Connect(name)

Parameters

root
Required. String containing the root collection that serves as a starting point to locate top-level collections.

object
Required. An object variable that evaluates to a catalog object.

name
Required; String. String containing the name of a remote computer. To connect to a local computer, supply an empty string as this argument.

Remarks

The Connect method returns a root collection, which is bound to the connected computer. A root collection serves as a starting point to locate top-level collections, and does not contain any objects or properties.

Note that you can also use the GetCollection method to locate a package on the local computer without first having to call the Connect method.

You can get the following collections from the root collection:

Packages

RemoteComponents

RelatedCollectionInfo

ComputerList

LocalComputer

PropertyInfo

For a list of the MTS collections and their properties, see the Using MTS Collections topic.

See Also

GetCollection Method (CatalogCollection)


Count Property (CatalogCollection)

Returns an integer value indicating the number of objects in a collection.

Syntax

object.Count

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

Upon instantiation, a CatalogCollection object returns a count of zero. Call the Populate method to read from the CatalogCollection object, and then use the Count method to return the number of objects in the collection.

for a list of the MTS collections and their properties, see the Using MTS Collections topic.

See Also

Populate Method (CatalogCollection)


DataStoreMajorVersion Property (CatalogCollection)

Returns an integer value indicating the major version number of the catalog.

Syntax

object.DataStoreMajorVersion

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

See Also

DataStoreMinorVersion Property (CatalogCollection),


DataStoreMinorVersion Property (CatalogCollection)

Returns an integer value indicating the minor version number of the catalog.

Syntax

object.DataStoreMajorVersion

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

See Also

DataStoreMajorVersion Property (CatalogCollection)


ExportPackage Method (PackageUtil)

Exports a package.

Syntax

object.ExportPackage(PackID, FileName, Options)

Parameters

object
Required. An object variable that evaluates to a PackageUtil object.

PackID
Required; String. An object variable that specifies the package ID of the package to export.

FileName
Required; String. An object variable that provides the name of the package file to export.

Options
Required; Long. An integer value specifying export options. This parameter can be 0 or MtsExportUsers, which includes users in roles in the package file.


GetCLSIDs Method(ComponentUtil)

Returns an array of installable class identifiers (CLSIDs) in the component DLL and/or type library.

Syntax

object.GetCLSIDs(bstrDLLFile, bstrTypeLibFile, aCLSIDs)

Parameters

BstrDLLFile
Required; String. A string variable that evaluates to the path of the DLL that you want checked.

BstrTypeLibFile
Required; String. A string variable that evaluates to the path of the type library that you want checked. If the type library is embedded with the DLL (as is the case with DLLs generated by Microsoft Visual Basic), this parameter should be an empty string).

aCLSIDS
Required; Variant. An output array of CLSIDs (VARIANTS) that can be installed from the supplied DLL and/or type library.


GetCollection Method (Catalog)

Instantiates a CatalogCollection object.

Syntax

set x object.GetCollection(Name)

Parameters

x
Required. An object variable (a variant, or object variable, or a CatalogCollection variable) for the returned collection.

object
Required. An object variable that evaluates to a catalog object.

Name
Required; String. A string expression containing the name of the collection to instantiate.

Remarks

You can use this method to get the following collections:

Packages

ComputerList

LocalComputer

RemoteComponents

RelatedCollectionInfo

After using the GetCollection method, you must fill the object by calling the Populate method. See the Populate method topic for further detail.

For a list of the MTS collections and their properties, see the Using MTS Collections topic..


GetCollection Method (CatalogCollection)

Retrieves a collection from the catalog.

Syntax

set x  object.GetCollection(name, key)

Parameters

x
Required. An object variable (a variant, or object variable, or a CatalogCollection variable) for the returned collection.

object
Required. An object variable that evaluates to a CatalogCollection object.

name
Required. A String expression containing the name of the collection to instantiate.

key
Required. A Variant expression containing the key of the object from which to navigate.

Remarks

Note that the GetCollection method gets an empty collection; you must call the Populate method to fill the collection.

For a list of the MTS collections and their properties, see the Using MTS Collections topic.

See Also

Populate Method (CatalogCollection),


GetUtilInterface Method (CatalogCollection)

Instantiates a utility object for the collection.

Syntax

set util  object.GetUtilInterface

Parameters

util
Required. An object variable that evaluates to a catalog utility object.

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

Call the GetUtilInterface method to instantiate any one of the PackageUtil, ComponentUtil, RemoteComponentUtil, and RoleAssociationUtil utility objects. This method is only supported on Packages, ComponentsInPackage, RemoteComponents, RolesForPackageComponent, and RolesForPackageComponentInterface collections.

For a list of the MTS collections and their properties, see the Using MTS Collections topic.


ImportComponent Method (ComponentUtil)

Imports a component that is already registered as an in-process (in-proc) server.

Syntax

object.ImportComponent(CLSID)

Parameters

object
Required. An object variable that evaluates to a ComponentUtil object.

CLSID
Required; String. An expression containing the CLSID of the component to be installed.

Remarks

The changes are applied immediately to the catalog.

For a description of the Component collection and its associated properties, see the Using MTS Collections topic.

See Also

ImportComponentByName Method (ComponentUtil)


ImportComponentByName Method (ComponentUtil)

Imports a component that is already registered as an in-process server by the component’s programmatic identifier (ProgID).

Syntax

object.ImportComponentByName(ProgID)

Parameters

object
Required. An object variable that evaluates to a ComponentUtil object.

ProgID
Required. A String expression identifying the ProgID of the component to be installed.

Remarks

The changes are applied immediately to the catalog. For a description of the Component collection and its associated properties, see the Using MTS Collections topic.

See Also

ImportComponent Method (ComponentUtil)


InstallComponent Method (ComponentUtil)

Installs a component into a package.

Syntax

object.InstallComponent(filepath, typelibrary, proxy-stub)

Parameters

object
Required. An object variable that evaluates to a ComponentUtil object.

filepath
Required. A String expression that provides the file path of the DLL containing the components to install.

typelibrary
Required. A String expression that provides the file path of the type library to use. Pass an empty string as this argument if the type library is embedded in the DLL.

proxy-stub
Required. A String expression that provides the file path of a custom proxy-stub DLL to use. Pass an empty string as this argument if there is no custom proxy-stub DLL.

Remarks

The changes are applied immediately to the catalog.

For a description of the Components collection and its associated properties, see the Using MTS Collections topic.

See Also

InstallRemoteComponent Method (RemoteComponentUtil), InstallRemoteComponentByName Method (RemoteComponentUtil)


InstallPackage Method (PackageUtil)

Installs a component or components that are valid within a package's collection.

Syntax

object.InstallPackage(FileName, InstallPath, options)

Parameters

object
Required. An object variable that evaluates to a Package utility object.

FileName
Required; String. String expression evaluating to the name of the package to install.

InstallPath
Required; String. String expression evaluating to the install path for component files.

options
Required; Long. A long value specifying install options. This parameter can be 0 or mtsInstallUsers, which adds users saved in the package file. If this option is not specified, users saved in the package file are not installed.

Remarks

All component files must be in the same directory of the package file. Component files arecopied to the install path specified as an argument of the InstallPackage method.

The changes are applied immediately to the catalog.

For a description of the Components collection and its associated properties, see the Using MTS Collections topic..


InstallRemoteComponent Method (RemoteComponentUtil)

Pulls remote components from a package on a remote server.

Syntax

object.InstallRemoteComponent(computer, PackID, CLSID)

Parameters

object
Required. An object variable that evaluates to a RemoteComponentUtil object.

computer
Required; String. A string expression providing the name of the remote computer.

PackID
Required; String. A string expression providing the package identification of the package containing the remote component.

CLSID
Required; String. A string expression containing the CLSID of the remote component.

Remarks

The changes are applied immediately to the catalog.

See the Working with Remote MTS Computers topic for a complete description of how to pull components from a remote server.

See Also

InstallRemoteComponentByName Method (RemoteComponentUtil)


InstallRemoteComponentByName Method (RemoteComponentUtil)

Pulls remote components by name from the package on a remote server.

Syntax

object.InstallRemoteComponentByName(computer, PackName, ProgID)

Parameters

object
Required. An object variable that evaluates to a RemoteComponentUtil object.

computer
Required; String. A string expression providing the name of the remote computer.

PackName
Required; String. A string expression providing the name of the package containing the remote component.

ProgID
Required; String. A string value containing the ProgID of the remote component.

Remarks

The changes are applied immediately to the catalog. See the Working with Remote MTS Computers topic for a complete description of how to pull components from a remote server.

See Also

InstallRemoteComponent Method (RemoteComponentUtil)


IsPropertyReadOnly Property (CatalogObject)

Returns a Boolean value that indicates if the property for an object is set to read-only.

Syntax

object.IsPropertyReadOnly(value)

Parameters

object
Required. An object variable that evaluates to a catalog object property.

value
Required. The name of the value for which to check the read-only property.

Remarks

If the value returned by the IsPropertyReadOnly method is True, then you cannot modify the property. If the value returned is False, you can modify the property using the Value property.


IsPropertyWriteOnly Property (CatalogObject)

Returns a Boolean value that indicates if the property for an object is set to write-only.

Syntax

object.IsPropertyWriteOnly(propertyname)

Parameters

object
Required. An object variable that evaluates to a catalog object property.

propertyname
Required. The name of the property for which to check the write-only status.

Remarks

If the value returned by the IsPropertyWriteOnly method is True, then you can write but not read the property value. If the value returned is False, you can read the property value.

See Also

IsPropertyReadOnly Property (CatalogObject)


Item Property (CatalogCollection)

Gets a specific object in a collection.

Syntax

object.Item(index)

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

index
Required; Long. A zero-based index that specifies the position of a member of the collection. Must be a number from 0 through the value of the collection's Count property -1.


Key Property (CatalogObject)

Gets the value of the key of the object.

Syntax

object.Key

Parameters

object
Required. An object variable that evaluates to a CatalogObject object.

Remarks

All catalog objects have a key. The object key is a single property that uniquely identifies the object. To access a related collection using the GetCollection method, provide the key of the object from which you want to navigate (such as the package identifier). The following table provides the key property for each collection supported:

Collection	Key Property
Packages	ID
ComponentsInPackage	CLSID
RolesInPackage	ID
RolesForPackageComponent	ID
RolesForPackageComponentInterface	ID
UsersInRole	User
InterfacesForComponent	IID
InterfacesForRemoteComponent	IID
RemoteComponents	CLSID
MethodsForInterface	Name


MajorVersion Property (Catalog)

Returns an integer value indicating the major version number of the catalog.

Syntax

object.MajorVersion

Parameters

object
Required. An object variable that evaluates to a catalog object.

See Also

MinorVersion Property (Catalog)


MinorVersion Property (Catalog)

Returns an integer value indicating the minor version number of the catalog.

Syntax

object.MinorVersion

Parameters

object
Required. An object variable that evaluates to a catalog object.

See Also

MajorVersion Property (Catalog)


Name Property (CatalogObject)

Gets the name of an object.

Syntax

object.Name

Parameters

object
Required. An object variable that evaluates to a catalog object.

Remarks

All catalog objects have a name property. The following table provides the name property for each collection supported:

Collection	Name Property
Packages	Name
ComponentsInPackage	ProgID
RolesInPackage	Name
RolesForPackageComponent	Name
RolesForPackageComponentInterface	Name
UsersInRole	User
InterfacesForComponent	Name
InterfacesForRemoteComponent	Name
RemoteComponents	ProgID
MethodsForInterface	Name


Name Property (CatalogCollection)

Gets the name of the collection.

Syntax

object.Name

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

See the Using MTS Collections topic for a list of properties supported by each MTS collection.


Populate Method (CatalogCollection)

Fills a collection with objects from the catalog.

Syntax

object.Populate

Parameters

object
Required. An object variable that evaluates to the CatalogCollection object that you would like to fill.

Remarks

The Populate method reads the contents of the CatalogCollection object. Any changes that are still pending (such as property changes, objects added, or objects removed) are lost. See the SaveChanges method topic for instruction on how to preserve changes made to a CatalogCollection object.


PopulateByKey Method (CatalogCollection)

Populates the collection with information for the specified objects.

Syntax

object.PopulateByKey(aCLSIDs)

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

aCLSIDS
Required; Variant. An array of object keys (VARIANTS) denoting which objects should have their information read from the catalog.


Remove Method (CatalogCollection)

Removes an item from an object given the index position.

Syntax

object.Remove(index)

Parameters

object
Required; String. An object variable that evaluates to a CatalogCollection object.

index
Required; Long. A zero-based index indicating the position of the object to remove.

Remarks

The object is removed from the collection and all objects with higher indices are shifted up. Note that the Count property of a collection changes after the Remove method has been called.

Call the SaveChanges method to save the changes made to the collection using the Remove method.


RemoveEnabled Property (CatalogCollection)

Returns a Boolean value indicating that you can use the Remove method to delete an object from the collection.

Syntax

object.RemoveEnabled

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

If the value returned is True, then you can call the Remove method to remove an object from the collection. If the value returned is False, objects cannot be removed from the collection.


SaveChanges Method (CatalogCollection)

Saves changes to a collection in the catalog, and returns an integer indicating the number of changes applied to the collection.

Syntax

object.SaveChanges

Parameters

object
Required. An object variable that evaluates to a CatalogCollection object.

Remarks

The SaveChanges method works exclusively on the collection on which you call it, and applies all pending changes to the catalog. If no changes are pending, then the method returns zero.

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ShutdownPackage Method (PackageUtil)

Initiates the shutting down of a package. Shutting down a package terminates that application’s process.

Syntax

object.ShutdownPackage(bstrPackageID)

Parameters

object
Required. An object variable that evaluates to a PackageUtil object.

bstrPackageID
Required. A string variable that evaluates to the PackageID of a Package CatalogObject.

Remarks

The ShutdownPackage method shuts down a single package process.

See the Using MTS Collections topic for a list of the MTS collections and their properties.


Valid Property (CatalogObject)

Returns a Boolean value indicating whether all the object properties were successfully read from the catalog.

Syntax

object.Valid

Parameters

object
Required. An object variable that evaluates to a CatalogObject.

Remarks

If this property is False it indicates that one or more object properties could not be read from the catalog during a call to Populate. This property will be True for objects that have been added to the collection using the Add method.


Value Property (CatalogObject)

Gets or sets a value for an object property.

Syntax

object.Value(property) value

Parameters

object
Required. An object variable that evaluates to a CatalogObject.

property
Required. A String expression of any type that specifies the name of the property whose value to get or set.

value
Required. A String expression that specifies the value of the property to get or set.

Remarks

See the Using MTS Collections topic for a description the properties supported by the MTS administration objects.


Automating MTS Administration With Visual C++

The topics in this section describe administration interfaces supported by Microsoft Transaction Server (MTS). This reference describes the following topics:

MTS Visual C++ Error Codes

ICatalog

ICatalogObject

ICatalogCollection

IPackageUtil

IComponentUtil

IRemoteComponentUtil

IRoleAssociationUtil

The ICatalog, ICatalogObject, and ICatalogCollection interfaces provide top-level functionality such as creating and modifying objects. The ICatalog interface enables you to connect to specific servers and access collections. Call the ICatalogCollection interface to enumerate, create, delete, and modify objects, as well as to access related collections. The ICatalogObject interface is used to get and set properties on an object.

The utility interfaces (IRemoteComponentUtil and IRoleAssociationUtil)  allows you to program very specific tasks for collection types, such as associating a role with a user or class of users.


MTS Visual C++ Error Codes

The following is a list of the error codes returned by methods called on the  catalog collection and catalog utility interfaces.

E_INVALIDARG
Indicates one of the following:

An invalid collection or property name was entered.

An out parameter was NULL.

The value is not one of the supported values or falls outside the supported range.

The property is read-only.

The property cannot be changed after the object is created.

An invalid index was entered.

E_NOTIMPL
Object has been removed from the collection and is not supported on this collection.

E_MTS_OBJECTERRORS
Errors were encountered processing some objects or file. See the ErrorInfo collection for object/file-specific error codes.

E_MTS_NOUSER
User ID for user in role is not valid.

E_MTS_USERPASSWDNOTVALID
Package identity user ID and/or password are not valid

E_MTS_AUTHENICATIONLEVEL
Required authentication level (package privacy) could not be set for package updates.

E_MTS_PDFREADFAIL
An error occurred reading the package file.

E_MTS_PDFVERSION
Package file version is invalid.

E_MTS_BADPATH
Package file path is invalid.

E_MTS_PACKAGEEXISTS
Package with the same ID is already installed.

E_MTS_ROLEEXISTS
A role with the same ID is already installed. The role ID in the package file is likely corrupted.

E_MTS_CANTCOPYFILE
Errors occurred copying one or more files to the install directory.

E_MTS_INVALIDUSERIDS
One or more user IDS for roles were invalid.

E_MTS_CLSIDORIIDMISMATCH
One or more component/interface identifiers in a component DLL does not match the identifiers saved in the package file. The package file is out of date.

E_MTS_PACKDIRNOTFOUND
Package install directory is invalid due to general registry read/write errors.

E_MTS_PDFWRITEFAIL
An error occurred writing the package file.

E_MTS_NOTYPELIB
Could not find the type library for one or more components.

The following is a list of the object or file-specific error codes returned in ErrorInfo collections:

E_OBJECTINVALID
One or more object properties is corrupted or invalid.

E_KEYMISSING
One or more objects is not found in the catalog.

E_ALREADYINSTALLED
Component is already installed.

E_DOWNLOADFAILLED
One or more component files could not be copied to the client.

E_REMOTEINTERFACE
No interface information is available for the component. Component files could not be downloaded.

E_COREQCOMPINSTALLED
Component in the same DLL file is already installed.

E_NOREGISTRYCLSID
Component’s CLSID is corrupted.

E_BADREGISTRYPROGID
Component’s ProgID is corrupted.

E_DLLLOADFAILED
Component’s DLL could not be loaded.

E_DLLREGISTERSERVER
DllRegisterServer method failed during component self-registration.

E_NOSERVERSHARE
No file share is available on the server to copy component files from the network path.

E_NOACCESSTOUNC
Network path registered for this component could not be accessed.

E_BADREGISTRYLIBID
Component type library ID is corrupted.

E_TREATAS
Component TreatAs key was found, but is not supported.

E_BADFORWARD
IID forward entry is corrupted.

E_BADIID
IID is corrupted.

E_REGISTRARFAILED
Component registrarmethod failed during component install.

E_COMFILE_DOESNOTEXIST
Component file does not exist.

E_COMFILE_LOADDLLFAIL
DLL file could not be loaded.

E_COMFILE_GETCLASSOBJ
DllGetClassObject method call failed during the DLL self-registration process.

E_COMFILE_CLASSNOTAVAIL
Class coded in the type library was not supported.

E_COMFILE_BADTLB
Type library was corrupted.

E_COMFILE_NOTINSTALLABLE
File does not contain COM components or type library information.

The following is a list of general read and write registry errors:

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

E_MTS_NOTCHANGEABLE
Changes to this object and sub-objects have been disabled.

E_MTS_NOTDELETABLE
Delete function for this object has been disabled.

E_MTS_SESSION
Server catalog version is not supported.


MTS ICatalog Interface

The Catalog object enables you to connect to specific servers and access collections. The ICatalog interface contains the following methods:

ICatalog::GetCollection

ICatalog::Connect

ICatalog::get_MajorVersion

ICatalog::get_MinorVersion


ICatalog::GetCollection

The GetCollection method retrieves a local collection without reading any objects from the catalog.

Syntax

HRESULT ICatalog::GetCollection(

BSTR	bstrCollName
IDispatch **	ppCatalogCollection);
Parameters

bstrCollName [in]
BSTR containing the name of the collection to retrieve from the catalog.

ppCatalogCollection [out]
Pointer to a pointer to the CatalogCollection object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid collection name passed as a parameter. Can also indicate that an Out parameter is NULL.


ICatalog::Connect

The Connect method connects to a remote computer and returns a root collection, which is bound to a remote computer.

HRESULT ICatalog::Connect(

BSTR	bstrConnectString
IDispatch **	ppCatalogCollection);
Parameters

bstrConnectString [in]
BSTR expression containing the name of a remote computer.

ppCatalogCollection [out]
Pointer to a pointer to the CatalogCollection object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Comments

A root collection serves as a starting point to locate packages, and contains neither objects nor properties. Note that you can also use the GetCollection method to get a top-level collection on a local server without using the Connect method.


ICatalog::get_MajorVersion

The get_MajorVersion method returns the major version number of an administration object.

HRESULT ICatalog::get_MajorVersion(

long*	retval);
Parameters

retval [out]
Pointer to the major version number of the MTS object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Comments

Call the get_MajorVersion method and the get_MinorVersion method to determine if you are using the most current version of MTS


ICatalog::get_MinorVersion

The get_MinorVersion method retrieves the minor version number of an MTS administration object.

HRESULT ICatalog::get_MinorVersion(
long * 	retval
);

Parameters

retval [out]
Pointer to the minor version number of the MTS object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Comments

Call the get_MajorVersion method and the get_MinorVersion method to determine if you are using the most current version of MTS.


MTS ICatalogCollection Interface

The CatalogCollection object can be used to enumerate objects, create, delete, and modify objects, and access related collections. The ICatalogCollection interface contains the following methods:

ICatalogCollection::get_NewEnum

ICatalogCollection::get_Item

ICatalogCollection::get_Count

ICatalogCollection::Remove

ICatalogCollection::Add

ICatalogCollection::Populate

ICatalogCollection::SaveChanges

ICatalogCollection::GetCollection

ICatalogCollection::get_Name

ICatalogCollection::get_AddEnabled

ICatalogCollection::get_RemoveEnabled

ICatalogCollection::GetUtilInterface

ICatalogCollection::get_DataStoreMajorVersion

ICatalogCollection:: get_DataStoreMinorVersion

ICatalogCollection::PopulateByKey


ICatalogCollection::get_NewEnum

The get_NewEnum method returns the IEnumVariant enumerator interface.

HRESULT ICatalogCollection::get_NewEnum(

IUnknown **	ppEnumVariant);
Parameters

ppEnumVariant [out]
Pointer to a pointer to the IEnumVariant interface.

Return Values

S_OK
Method completed successfully.

INVALIDARG
Out parameter is NULL.


ICatalogCollection::get_Item

The get_Item method returns an object from the collection represented by the index.

HRESULT ICatalogCollection::get_Item(

long	1Index
IDispatch**	ppCatalogObject);
Parameters

1Index [in]
Index to the object in the collection.

ppCatalogObject [out]
Pointer to a pointer to the Catalog object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out of range of index.

Comments

A collection object contains zero or more items (all MTS collections are zero-based).

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::get_Count

The get_Count method returns the number of objects in the collection.

HRESULT ICatalogCollection::get_Count(

long *	retval);
Parameters

retval [out]
Pointer to the number of elements in the object collection.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::Add

The Add method adds a default object to the collection and returns a pointer to the new object.

HRESULT ICatalogCollection::Add(

IDispatch **	ppCatalogObject);
Parameters

ppCatalogObject [out]
Pointer to a pointer to the new Catalog object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

E_NOTIMPL
Not supported on this collection.

Remarks

To update the objects in a collection, call the Add method to create a new object either before or after populating a collection.

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::Populate

The Populate method reads the collection objects from the catalog.

HRESULT ICatalogCollection::Populate( );

Return Values

S_OK
Method completed successfully.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

E_MTS_OBJECTERRORS
Collection was read but some objects were invalid. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

Remarks

You call the Populate method to fill a package collection with objects from the catalog. This method uses the CoCreateInstance function internally, so CoCreateInstance error codes are included in the Populate method’s return values.

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::SaveChanges

The SaveChanges method saves changes to the collection into the catalog.

HRESULT ICatalogCollection::SaveChanges(

long *	retval);
Parameters

retval [out]
Number of changes applied to the collection.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

E_MTS_OBJECTERRORS
Errors were encountered processing some objects. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOUSER
User ID is invalid.

E_MTS_USERPASSWDNOTVALID
Package identity user ID and/or password are invalid.

E_MTS_AUTHENTICATIONLEVEL
Required authentication level (package privacy) could not be set for package updates.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

CLASS_E_NOAGGREGATION
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

You must call this method after modifying any object in the collection. The SaveChanges method works exclusively on the collection on which it is called. This method also applies all pending changes to objects within a given collection. This method uses the CoCreateInstance function internally, so CoCreateInstance error codes are included in the SaveChanges method’s return values.

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::GetCollection

The GetCollection method retrieves a collection related to a specific object. Data is not read from the catalog. See the Populate method topic for more information.

HRESULT ICatalogCollection::GetCollection(

BSTR	bstrCollName
VARIANT	varObjectKey
IDispatch **	ppCatalogCollection);
Parameters

bstrCollName [in]
BSTR containing the name of the collection.

VarObjectKey [in]
Value of the object key.

retval [out]
Pointer to a pointer to the CatalogCollection object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid collection name passed as a parameter. Can also indicate that an Out parameter is NULL.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::get_Name

The get_Name method gets the name of a collection.

HRESULT ICatalogCollection::get_Name(
VARIANT*	retval);

Parameters

retval [out]
Pointer to the name of the collection.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::get_AddEnabled

The get_AddEnabled method returns a value that indicates if the Add method is supported in this collection.

HRESULT ICatalogCollection::get_AddEnabled(
VARIANT_BOOL*	varAddEnabled);

Parameters

VarObjectKey [out]
Boolean value indicating if the Add method is supported in this collection.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::Remove

The Remove method removes an item from a collection, given the index of the item.

HRESULT ICatalogCollection::Remove(
long	1Index);

Parameters

1Index [in]
Index position of the object to remove.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid index was entered.

E_NOTIMPL
Collection does not support removing objects.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::get_RemoveEnabled

The get_RemoveEnabled method returns a value that indicates if the Remove method is supported in this collection.

HRESULT ICatalogCollection:: get_RemoveEnabled(
VARIANT_BOOL * 	boolRemoveEnabled);

Parameters

boolRemoveEnabled [out]
Boolean value indicating if the Remove method is supported in this collection.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::GetUtilInterface

The GetUtilInterface method returns a pointer to the interface of the utility object for a package, component, remote component, or role collection.

HRESULT ICatalogCollection::GetUtilInterface(
IDispatch**	ppUtil);

Parameters

ppUtil [out]
Pointer to a pointer to the interface on a utility object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

E_NOTIMPL
Not supported on this collection.

Remarks

Call the GetUtilInterface method to program your application for specific administration tasks, such as creating a package or installing a component.

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogCollection::get_DataStoreMajorVersion

The get_DataStoreMajorVersion method returns the major version number of the catalog from which you get the collection.

HRESULT ICatalogCollection::get_DataStoreMajorVersion(
long * 	retval);

Parameters

retval [out]
Pointer to a pointer to the MTS major version number.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

See Also

get_DataStoreMinorVersion


ICatalogCollection::get_DataStoreMinorVersion

The get_DataStoreMinorVersion method returns the minor version number of the catalog from which you get a collection.

HRESULT ICatalogCollection:: get_DataStoreMinorVersion(
long * 	retval);

Parameters

retval [out]
Pointer to a pointer to the MTS minor version number.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

See Also

get_DataStoreMajorVersion


ICatalogCollection::PopulateByKey

The PopulateByKey method populates the collection with information for the specified objects.

HRESULT ICatalogCollection::PopulateByKey(
SAFEARRAY * 	saKeys);

Parameters

saKeys [in]
Pointer to a safearray of VARIANTs containing the CLSIDs of components for which the collection object should refresh its information.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


MTS ICatalogObject Interface

The CatalogObject object provides methods to get and set properties on an object. The ICatalogObject interface contains the following methods:

ICatalogObject::get_Value

ICatalogObject::put_Value

ICatalogObject::get_Key

ICatalogObject::get_Name

ICatalogObject::IsPropertyReadOnly

ICatalogObject::IsPropertyWriteOnly

ICatalogObject::get_Valid


ICatalogObject::get_Value

The get_Value method gets a property value of an object in a collection.

HRESULT ICatalogObject::get_Value(

BSTR	bstrPropName
VARIANT *	retval);
Parameters

bstrPropName [in]
BSTR expression containing the name of the property.

retval [out]
Pointer to the value of the property.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid property name passed as a parameter. Can also indicate that an Out parameter is NULL.

E_NOTIMPL
Object has been removed from the collection.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogObject::put_Value

The put_Value method sets the property value of an object in a collection.

HRESULT ICatalogObject::put_Value(

BSTR	bstrPropName
VARIANT	val);
Parameters

bstrPropName [in]
BSTR containing the name of the property to set.

val [in]
Variant containing the new value for the property.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid property name entered. Can also indicate either the property value is not one of the supported values or falls outside the supported range, the property is read-only, or the property cannot be changed after the object is created.

E_NOTIMPL
Object has been removed from the collection.

Remarks

See the Using MTS Collections topic for a list of the MTS collections and their properties.


ICatalogObject::get_Key

The get_Key method gets the value of the Key property.

HRESULT ICatalogObject::get_Key(

VARIANT*	retval);
Parameters

retval [out]
Pointer to the value of the Key property.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

E_NOTIMPL
Object has been removed from the collection.

Comments

All MTS objects have a key. The object key is a single property that uniquely identifies the object. To create a related collection in your Package collection object, provide the key of the object from which you want to navigate (such as the package identifier). The following table provides the key property for each collection supported by the MTS Explorer.

Collection	Key Property
Packages	ID
ComponentsInPackage	CLSID
RolesInPackage	ID
RolesForPackageComponents	ID
UsersInRole	User
InterfacesForComponent	IID
InterfacesForRemoteComponent	IID


ICatalogObject::get_Name

The get_Name method provides the name of an object in the catalog.

HRESULT ICatalogObject::get_Name(

VARIANT *	retval );
Parameters

retval [out]
Pointer to the name of the object.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

E_NOTIMPL
Object has been removed from the collection.

All MTS objects have a name property. The following table provides the name property for each collection supported by the MTS Explorer:

Collection	Name Property
Packages	Name
ComponentsInPackage	ProgID
RolesInPackage	Name
RolesForPackageComponents	Name
UsersInRole	User
InterfacesForComponent	Name
InterfacesForRemoteComponent	Name
RemoteComponents	ProgID
MethodsForInterface	Name


ICatalogObject::IsPropertyReadOnly

The IsPropertyReadOnly method determines if a property is read-only.

HRESULT ICatalogObject::IsPropertyReadOnly(

BSTR	bstrPropName
VARIANT_BOOL *	retval);
Parameters

bstrPropName [in]
BSTR containing the name of the property.

retval [out]
Boolean indicating if the property is read-only.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid property name passed as a parameter. Can also indicate that an Out parameter is NULL.

Remarks

For more information about read-only property values and collections, see the Using MTS Collections topic.

See Also

IsPropertyWriteOnly


ICatalogObject::IsPropertyWriteOnly

The IsPropertyWriteOnly method indicates if a property can be written but not read.

HRESULT ICatalogObject::IsPropertyWriteOnly(

BSTR	bstrPropName
VARIANT_BOOL *	retval);
Parameters

bstrPropName [in]
BSTR containing the name of the property that may or may not be write-only.

retval [out]
Boolean indicating if the property is write-only.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Invalid property name passed as a parameter. Can also indicate that an Out parameter is NULL.

Remarks

For more information about read-only property values and collections, see the Using MTS Collections topic.

See Also

IsPropertyReadOnly


ICatalogObject::get_Valid

The get_Valid method determines if properties on an object were successfully read from the catalog.

HRESULT ICatalogObject::get_Valid(

VARIANT_BOOL *	retval);
Parameters

retval [out]
Boolean indicating if properties were successfully read. If this method returns True, all properties on an object were read from the catalog.

Return Values

S_OK
Method completed successfully.

E_INVALIDARG
Out parameter is NULL.

E_NOTIMPL
Object removed from the collection.


MTS IPackageUtil Interface

The IPackageUtil object enables a package to be installed and exported within the Packages collection. The IPackageUtil interface contains the following methods:

IPackageUtil::InstallPackage

IPackageUtil::ExportPackage

IPackageUtil::ShutdownPackage

See the Using MTS Collections topic for a list of the MTS collections and their properties.


IPackageUtil::InstallPackage

The InstallPackages method installs a pre-built package.

HRESULT IPackageUtil::InstallPackage(

BSTR	bstrPackageFile
BSTR	bstrInstallPath
long	1Options);
Parameters

bstrPackageFile [in]
BSTR containing the name of the package file to install.

bstrInstallPath [in]
BSTR containing component install path.

1Options [in]
Integer specifying export options. This method supports MtsExportUsers, which includes users in roles in the package file.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing objects and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_PDFREADFAIL
Error occurred reading the package file.

E_MTS_PDFVERSION
Package file version is invalid.

E_MTS_BADPATH
Package file path is invalid.

E_MTS_PACKAGEEXISTS
Package with the same ID is already installed.

E_MTS_ROLEEXISTS
Role with the same ID is already installed. The role ID in the package file is likely corrupted.

E_MTS_CANTCOPYFILE
Errors occurred copying one or more files to the install directory.

E_MTS_INVALIDUSERIDS
One or more user IDs for roles were invalid.

E_MTS_CLSIDORIIDMISMATCH
One or more component/interface identifiers in a component DLL do not match the identifiers saved in the package file. The package file is likely out of date.

E_MTS_PACKDIRNOTFOUND
The package install directory is invalid.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the InstallPackage method’s return values.


IPackageUtil::ExportPackage

The ExportPackage method exports a package according to its package identifier.

HRESULT IPackageUtil::ExportPackage(

BSTR	bstrPackageID
BSTR	bstrPackageFile
long	1Options);
Parameters

bstrPackageID [in]
BSTR containing the unique identifier of the package to export.

bstrPackageFile [in]
BSTR containing the name of the package file to export.

1Options [in]
Either zero (for no option selected) or MtsExportUsers, which includes users in roles in the package file.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing objects and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_PDFWRITEFAIL
Error occurred writing the package file.

E_MTS_NOTYPELIB
Could not find the type library for one or more components.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the ExportPackage method’s return values.


IPackageUtil::ShutdownPackage

The ShutdownPackage method shuts down a single package, thereby terminating that application process.

HRESULT IPackageUtil::ShutdownPackage(

BSTR	bstrPackageID
Parameters

bstrPackageID [in]
BSTR containing the unique identifier of the package to shut down.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing objects and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_PDFWRITEFAIL
Error occurred writing the package file.

E_MTS_NOTYPELIB
Could not find the type library for one or more components.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.


MTS IComponentUtil Interface

The IComponentUtil object provides methods to install a component in a specific collection and to import components registered as an in-proc server. The IComponentUtil interface contains the following methods:

IComponentUtil::InstallComponent

IComponentUtil::ImportComponent

IComponentUtil::ImportComponentByName

IComponentUtil::GetCLSIDs


IComponentUtil::InstallComponent

The InstallComponent method installs a component.

HRESULT IComponentUtil::InstallComponent(

BSTR	bstrDLLFile
BSTR	bstrTypelibFile
BSTR	bstrProxyStubDLL);
Parameters

bstrDLLFile [in]
BSTR containing the name of the DLL file providing the components to install.

bstrTypelibFile [in]
BSTR containing the name of the external type library file. If the type library file is embedded in the DLL, pass in an empty string for this parameter.

bstrProxyStubDLL [in]
BSTR containing the name of the proxy-stub DLL file. If there is no proxy-stub DLL associated with the component, pass in an empty string for this parameter.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing components and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the InstallComponent method’s return values.


IComponentUtil::ImportComponent

The ImportComponent method imports a component that is already registered as an in-process (in-proc) server.

HRESULT IComponentUtil::ImportComponent(

BSTR	bstrCLSID);
Parameters

bstrCLSID [in]
BSTR containing the CLSID of the component to import.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing components and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the ImportComponent method’s return values.

See Also

ImportComponentByName


IComponentUtil::ImportComponentByName

The ImportComponentByName method imports a component that is already registered as an in-process (in-proc) server. This method uses the component’s programmatic identifier (ProgID) for the import procedure.

HRESULT IComponentUtil::ImportComponentByName(

BSTR	bstrProgID);
Parameters

bstrProgID [in]
BSTR containing the ProgID of the component to import.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing components and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the ImportComponentByName method’s return values.

See Also

ImportComponent


IComponentUtil::GetCLSIDs

The GetCLSIDs method fills an array with the installable component CLSIDs from a DLL and/or type library.

HRESULT IComponentUtil::GetCLSIDs(

BSTR	bstrDLLFile
BSTR	bstrTypeLibFile
SAFEARRAY**	ppsaCLSIDs)
Parameters

bstrDLLFile [in]
BSTR containing the name of the DLL file providing the components to check for allowable installation.

bstrTypeLibFile [in]
BSTR containing the name of the external type library file to check for installable components.

ppsaCLSIDs [out]
Pointer to a pointer to a SAFEARRAY containing VARIANTS which contain the CLSIDs of installable components in the given DLL and/or type library.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing components and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.


MTS IRemoteComponentUtil Interface

You can use the IRemoteComponentUtil object to program your application to pull remote components from a package on a remote server. The IRemoteComponentUtil interface contains the following methods:

IRemoteComponentUtil::InstallRemoteComponent

IRemoteComponentUtil::InstallRemoteComponentByName


IRemoteComponentUtil::InstallRemoteComponent

The InstallRemoteComponent method pulls a component to install from a package on a remote server.

HRESULT IRemoteComponentUtil::InstallRemoteComponent(

BSTR	bstrServer
BSTR	bstrPackageID
BSTR	bstrCLSID);
Parameters

bstrServer [in]
BSTR containing the name of the remote server from which to pull the component to install.

PackageID [in]
BSTR containing the identifier of the package containing the remote component.

bstrCLSID [in]
BSTR containing the class identifier (CLSID) of the remote component.

Return Values

S_OK
Method returned successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing components and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the InstallRemoteComponent method’s return values.

See Also

InstallRemoteComponentByName


IRemoteComponentUtil::InstallRemoteComponentByName

The InstallRemoteComponentByName method pulls remote components from the package on a remote server and installs the component by package name and programmatic ID (ProgID).

HRESULT IRemoteComponentUtil::InstallRemoteComponentByName(

BSTR	bstrSever
BSTR	PackageName
BSTR	bstrProgID);
Parameters

bstrSever [in]
BSTR containing the name of the remote server from which to pull the component to install.

PackageName [in]
BSTR containing the name of the package containing the remote component.

bstrProgID [in]
BSTR containing the ProgID of the component to install.

Return Values

S_OK
Method completed successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing objects. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the InstallRemoteComponentByName method’s return values.

See Also

InstallRemoteComponent


MTS IRoleAssociationUtil Interface

Call methods on the IRoleAssociationUtil object to associate roles with a component or component interface. The IRoleAssociationUtil interface contains the following methods:

IRoleAssociationUtil::AssociateRole

IRoleAssociationUtil::AssociateRoleByName


IRoleAssociationUtil::AssociateRole

The AssociateRole method associates a role with a component or component interface.

HRESULT IRoleAssociationUtil::AssociateRole(
BSTR	bstrRoleID
);

Parameters

bstrRoleID [in]
BSTR containing the ID of the role to associate with a component or component interface.

Return Values

S_OK
Method returned successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing objects. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the AssociateRole method’s return values.

See Also

AssociateRoleByName


IRoleAssociationUtil::AssociateRoleByName

The AssociateRoleByName method associates a role by its name with a specified component or component interface.

HRESULT IRoleAssociationUtil::AssociateRoleByName(

BSTR	bstrRoleName);
Parameters

bstrRoleName [in]
BSTR containing the name of the role to associate with a component or component interface.

Return Values

S_OK
Method returned successfully.

E_MTS_OBJECTERRORS
Errors were encountered processing components and/or files. See the ErrorInfo collection for object-specific error codes.

E_MTS_NOREGISTRYREAD
Access control failure reading a registry key.

E_MTS_NOREGISTRYWRITE
Access control failure writing a registry key.

E_MTS_NOREGISTRYREPAIR
Access control failure writing a registry key.

REGDB_E_CLASSNOTREG
The MTXCatEx.CatalogServer.1 component is not registered on the target computer. MTS is not installed properly on the target computer.

Remarks

Because this method uses the CoCreateInstance function internally, CoCreateInstance error codes are included in the AssociateRoleByName method’s return values.

See Also

AssociateRole


GetObjectContext

Visual Basic	GetObjectContext Function

Visual C++	GetObjectContext Function

Visual J++	MTx.GetObjectContext Method

Context.getObjectContext Method


SafeRef

Visual Basic	SafeRef Function

Visual C++	SafeRef Function

Visual J++	Context.safeRef Method

MTx.SafeRef Method


IObjectContext Interface, ObjectContext Object
IObjectContext Interface, ObjectContext Object, Context Class

Visual Basic	ObjectContext Object

Visual C++	IObjectContext Interface

Visual J++	Context Class

IObjectContext Interface


SetAbort Method

Visual Basic	SetAbort Method

Visual C++	IObjectContext::SetAbort Method

Visual Basic	Context.setAbort Method

IObjectContext.SetAbort Method


SetComplete Method

Visual Basic	SetComplete Method

Visual C++	IObjectContext::SetComplete Method

Visual J++	Context.setComplete Method

IObjectContext.SetComplete Method


EnableCommit Method

Visual Basic	EnableCommit Method

Visual C++	IObjectContext::EnableCommit Method

Visual J++	Context.enableCommit Method

IObjectContext.EnableCommit Method


DisableCommit Method

Visual Basic	DisableCommit Method

Visual C++	IObjectContext::DisableCommit Method

Visual J++	Context.disableCommit Method

IObjectContext.DisableCommit Method


CreateInstance Method

Visual Basic	CreateInstance Method

Visual C++	IObjectContext::CreateInstance Method

Visual J++	Context.createObject Method

IObjectContext.CreateInstance Method


IsInTransaction Method

Visual Basic	IsInTransaction Method

Visual C++	IObjectContext::IsInTransaction Method

Visual J++	Context.isInTransaction Method

IObjectContext.IsInTransaction Method


IsCallerInRole Method

Visual Basic	IsCallerInRole Method

Visual C++	IObjectContext::IsCallerInRole Method

Visual J++	Context.isCallerInRole Method

IObjectContext.IsCallerInRole Method


IsSecurityEnabled Method

Visual Basic	IsSecurityEnabled Method

Visual C++	IObjectContext::IsSecurityEnabled Method

Visual J++	Context.isSecurityEnabled Method

IObjectContext.IsSecurityEnabled Method


ITransactionContextEx Interface, TransactionContext Object

Visual Basic	TransactionContext Object

Visual C++	ITransactionContextEx Interface

Visual J++	ITransactionContextEx Interface


Abort Method

Visual Basic	Abort Method

Visual C++	ITransactionContextEx::Abort Method

Visual J++	ITransactionContextEx.Abort Method


Commit Method

Visual Basic	Commit Method

Visual C++	ITransactionContextEx::Commit Method

Visual J++	ITransactionContextEx.Commit Method


IObjectControl Interface

Visual Basic	ObjectControl Interface

Visual C++	IObjectControl Interface

Visual J++	IObjectControl Interface


Activate Method

Visual Basic	Activate Method

Visual C++	IObjectControl::Activate Method

Visual J++	IObjectControl.Activate Method


CanBePooled Method

Visual Basic	CanBePooled Method

Visual C++	IObjectControl::CanBePooled Method

Visual J++	IObjectControl.CanBePooled Method


Deactivate Method

Visual Basic	Deactivate Method

Visual C++	IObjectControl::Deactivate Method

Visual J++	IObjectControl.Deactivate Method


ISharedProperty Interface, SharedProperty Object

Visual Basic	SharedProperty Object

Visual C++	ISharedProperty Interface

Visual J++	ISharedProperty Interface


Value

Visual Basic	Value Property

Visual C++	ISharedProperty::get_Value Method

Visual C++	ISharedProperty::put_Value Method

Visual J++	ISharedProperty.getValue Method

Visual J++	ISharedProperty.putValue Method


ISharedPropertyGroup Interface, SharedPropertyGroup Object

Visual Basic	SharedPropertyGroup Object

Visual C++	ISharedPropertyGroup Interface

Visual J++	ISharedPropertyGroup Interface


CreateProperty Method

Visual Basic	CreateProperty Method

Visual C++	ISharedPropertyGroup::CreateProperty Method

Visual J++	ISharedPropertyGroup.CreateProperty Method


CreatePropertyByPosition Method

Visual Basic	CreatePropertyByPosition Method

Visual C++	ISharedPropertyGroup::CreatePropertyByPosition Method

Visual J++	ISharedPropertyGroup.CreatePropertyByPosition Method


Property

Visual Basic	Property Property

Visual C++	ISharedPropertyGroup::get_Property Method

Visual J++	ISharedPropertyGroup.getProperty Method

Context.getProperty Method

Context.getPropertyNames Method


PropertyByPosition

Visual Basic	PropertyByPosition Property

Visual C++	ISharedPropertyGroup::get_PropertyByPosition Method

Visual J++	ISharedPropertyGroup.getPropertyByPosition Method


ISharedPropertyGroupManager Interface, SharedPropertyGroupManager Object

Visual Basic	SharedPropertyGroupManager Object

Visual C++	ISharedPropertyGroupManager Interface

Visual J++	ISharedPropertyGroupManager Interface


CreatePropertyGroup Method

Visual Basic	CreatePropertyGroup Method

Visual C++	ISharedPropertyGroupManager::CreatePropertyGroup Method

Visual J++	ISharedPropertyGroupManager.CreatePropertyGroup Method


Group

Visual Basic	Group Property

Visual C++	ISharedPropertyGroupManager::get_Group Method

Visual J++	ISharedPropertyGroupManager.getGroup Method


get_NewEnum, get__NewEnum Methods

Visual C++	ISharedPropertyGroupManager::get__NewEnum Method

Visual J++	ISharedPropertyGroupManager.get_NewEnum Method


IGetContextProperties Interface

Visual C++	IGetContextProperties Interface

Visual J++	IGetContextProperties Interface


Count Method

Visual Basic	Count Method

Visual C++	Count Method

Visual J++	Count Method


EnumNames Method

Visual C++	EnumNames Method

Visual J++	EnumNames Method


GetProperty Method

Visual C++	GetProperty Method

Visual J++	GetProperty Method


ISecurityProperty Interface

Visual Basic	SecurityProperty Object

Visual C++	ISecurityProperty Interface


GetDirectCallerName Method

Visual Basic	GetDirectCallerName Method

Visual C++	GetDirectCallerSID Method

Visual J++	Context.getDirectCallerName Method


GetDirectCreatorName Method

Visual Basic	GetDirectCreatorName Method

Visual C++	GetDirectCreatorSID Method

Visual J++	Context.getDirectCreatorName Method


GetOriginalCallerName Method

Visual Basic	GetOriginalCallerName Method

Visual C++	GetOriginalCallerSID Method

Visual J++	Context.getOriginalCallerName Method


GetOriginalCreatorName Method

Visual Basic	GetOriginalCreatorName Method

Visual C++	GetOriginalCreatorSID Method

Visual J++	Context.getOriginalCreatorName Method


Post Method, Step1 (Visual Basic)

Public Function Post(ByRef lngAccount As Long, _

    ByRef lngAmount As Long) As String

    On Error GoTo ErrorHandler

    Post = "Hello from Account!!!"

    Exit Function

' Return the error message indicating that

' an error occurred.

ErrorHandler:

    Err.Raise Err.Number, "Bank.Account.Post", _

        Err.Description

End Function


Post Method, Step2 (Visual Basic)

Public Function Post(ByVal lngAccountNo As Long, _

    ByVal lngAmount As Long) As String

    Dim strResult As String

    On Error GoTo ErrorHandler

    ' obtain the ADO environment and connection

    Dim adoConn As New ADODB.Connection

    Dim varRows As Variant

    adoConn.Open strConnect

    On Error GoTo ErrorCreateTable

    ' update the balance

    Dim strSQL As String

    strSQL = "UPDATE Account SET Balance = Balance + "_

        + Str$(lngAmount) + " WHERE AccountNo = "

        + Str$(lngAccountNo)

TryAgain:

    adoConn.Execute strSQL, varRows

    ' if anything else happens

    On Error GoTo ErrorHandler

    ' get resulting balance which may have been

    ' further updated via triggers

    strSQL = "SELECT Balance FROM Account " _

        + "WHERE AccountNo = " + Str$(lngAccountNo)

    Dim adoRS As ADODB.Recordset

    Set adoRS = adoConn.Execute(strSQL)

    If adoRS.EOF Then

        Err.Raise Number:=APP_ERROR, _

            Description:="Error. Account " _

            + Str$(lngAccountNo) + " not on file."

    End If

    Dim lngBalance As Long

    lngBalance = adoRS.Fields("Balance").Value

    ' check if account is overdrawn

    If (lngBalance) < 0 Then

        Err.Raise Number:=APP_ERROR, _

            Description:="Error. Account " _

            + Str$(lngAccountNo) _

            + " would be overdrawn by " _

            + Str$(lngBalance) + ". Balance is still "

            + Str$(lngBalance - lngAmount) + "."

    Else

        If lngAmount < 0 Then

            strResult = strResult _

                & "Debit from account "

                & lngAccountNo & ", "

        Else

            strResult = strResult _

                & "Credit to account "

                & lngAccountNo & ", "

        End If

        strResult = strResult + "balance is $"

            & Str$(lngBalance) & ". (VB)"

    End If

    ' cleanup

    Set adoRS = Nothing

    Set adoConn = Nothing

    Post = strResult

Exit Function

ErrorCreateTable:

    On Error GoTo ErrorHandler

    ' create the account table

    Dim objCreateTable As CreateTable

    Set objCreateTable = _

    GetObjectContext.CreateInstance("Bank.CreateTable")

    objCreateTable.CreateAccount

    GoTo TryAgain

ErrorHandler:

    ' cleanup

    If Not adoRS Is Nothing Then

        Set adoRS = Nothing

    End If

    If Not adoConn Is Nothing Then

        Set adoConn = Nothing

    End If

    Post = ""         ' indicate that an error occurred

    Err.Raise Err.Number, "Bank.Accout.Post", _

        Err.Description

End Function


Post Method, Step3 (Visual Basic)

Public Function Post(ByVal lngAccountNo As Long, _

    ByVal lngAmount As Long) As String

    Dim strResult As String

    On Error GoTo ErrorHandler

    ' obtain the ADO environment and connection

    Dim adoConn As New ADODB.Connection

    Dim varRows As Variant

    adoConn.Open strConnect

    On Error GoTo ErrorCreateTable

    ' update the balance

    Dim strSQL As String

    strSQL = "UPDATE Account SET Balance = Balance + "_

        + Str$(lngAmount) + " WHERE AccountNo = "

        + Str$(lngAccountNo)

TryAgain:

    adoConn.Execute strSQL, varRows

    ' if anything else happens

    On Error GoTo ErrorHandler

    ' get resulting balance which may have been

    ' further updated via triggers

    strSQL = "SELECT Balance FROM Account " _

        + "WHERE AccountNo = " + Str$(lngAccountNo)

    Dim adoRS As ADODB.Recordset

    Set adoRS = adoConn.Execute(strSQL)

    If adoRS.EOF Then

        Err.Raise Number:=APP_ERROR, _

            Description:="Error. Account " _

            + Str$(lngAccountNo) + " not on file."

    End If

    Dim lngBalance As Long

    lngBalance = adoRS.Fields("Balance").Value

    ' check if account is overdrawn

    If (lngBalance) < 0 Then

        Err.Raise Number:=APP_ERROR, _

            Description:="Error. Account " _

            + Str$(lngAccountNo) _

            + " would be overdrawn by " _

            + Str$(lngBalance) + ". Balance is still "

            + Str$(lngBalance - lngAmount) + "."

    Else

        If lngAmount < 0 Then

            strResult = strResult _

                & "Debit from account "

                & lngAccountNo & ", "

        Else

            strResult = strResult _

                & "Credit to account "

                & lngAccountNo & ", "

        End If

        strResult = strResult + "balance is $"

            & Str$(lngBalance) & ". (VB)"

    End If

    ' cleanup

    Set adoRS = Nothing

    Set adoConn = Nothing

    ' we are finished and happy

    GetObjectContext.SetComplete

    Post = strResult

Exit Function

ErrorCreateTable:

    On Error GoTo ErrorHandler

    ' create the account table

    Dim objCreateTable As CreateTable

    Set objCreateTable = _

    GetObjectContext.CreateInstance("Bank.CreateTable")

    objCreateTable.CreateAccount

    GoTo TryAgain

ErrorHandler:

    ' cleanup

    If Not adoRS Is Nothing Then

        Set adoRS = Nothing

    End If

    If Not adoConn Is Nothing Then

        Set adoConn = Nothing

    End If

    GetObjectContext.SetAbort          ' we are unhappy

    Post = ""         ' indicate that an error occurred

    Err.Raise Err.Number, "Bank.Accout.Post", _

        Err.Description

End Function


Perform Method, Step4 (Visual Basic)

Public Function Perform(ByVal lngPrimeAccount As Long,_

    ByVal lngSecondAccount As Long, ByVal lngAmount _

    As Long, ByVal lngTranType As Long) As String

    Dim strResult As String

    On Error GoTo ErrorHandler

    ' create the account object using our context

    Dim objAccount As Bank.Account

    Set objAccount = _

        GetObjectContext.CreateInstance("Bank.Account")

    If objAccount Is Nothing Then

        Err.Raise ERROR_NUMBER, _

        Description:="Could not create account object"

    End If

    ' call the post function based on the

    ' transaction type

    Select Case lngTranType

        Case 1

            strResult = objAccount.Post(lngPrimeAccount, 0 - lngAmount)

            If strResult = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult

            End If

        Case 2

            strResult = objAccount.Post(lngPrimeAccount, lngAmount)

            If strResult = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult

            End If

        Case 3

            Dim strResult1 As String, strResult2 As String

            ' do the credit

            strResult1 = objAccount.Post(lngSecondAccount, lngAmount)

            If strResult1 = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult1

            Else

                ' then do the debit

                strResult2 = objAccount.Post(lngPrimeAccount, 0 - lngAmount)

                If strResult2 = "" Then

                ' debit failed

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult2

                Else

                    strResult = strResult1 + "  " + strResult2

                End If

            End If

        Case Else

            Err.Raise ERROR_NUMBER, _

                Description:="Invalid Transaction Type"

    End Select

    ' we are finished and happy

    GetObjectContext.SetComplete

    Perform = strResult

    Exit Function

ErrorHandler:

    GetObjectContext.SetAbort          ' we are unhappy

    Perform = ""       ' indicate that an error occured

    Err.Raise Err.Number, "Bank.MoveMoney.Perform", _

        Err.Description

End Function


GetNextReceipt Method, Step5 (Visual Basic)

Public Function GetNextReceipt() As Long

    On Error GoTo ErrorHandler

    ' If Shared property does not already exist

    ' it will be initialized

    Dim spmMgr As SharedPropertyGroupManager

    Set spmMgr = CreateObject("MTxSpm.SharedPropertyGroupManager.1")

    Dim spmGroup As SharedPropertyGroup

    Dim bResult As Boolean

    Set spmGroup = _

        spmMgr.CreatePropertyGroup("Receipt", _

        LockMethod, Process, bResult)

    Dim spmPropNextReceipt As SharedProperty

    Set spmPropNextReceipt = _

        spmGroup.CreateProperty("Next", bResult)

    ' Set the initial value of the Shared Property to

    ' 0 if the Shared Property didn’t already exist.

    ' This is not entirely necessary but demonstrates

    ' how to initialize a value.

    If bResult = False Then

        spmPropNextReceipt.Value = 0

    End If

    ' Get the next receipt number and update property

    spmPropNextReceipt.Value = spmPropNextReceipt.Value + 1

    ' we are finished and happy

    GetObjectContext.SetComplete

    GetNextReceipt = spmPropNextReceipt.Value

    Exit Function

ErrorHandler:

    GetObjectContext.SetAbort          ' we are unhappy

    ' indicate that an error occured

    GetNextReceipt = -1

    Err.Raise Err.Number, _

        "Bank.GetReceipt.GetNextReceipt", _

        Err.Description

End Function


Perform Method, Step5 (Visual Basic)

Public Function Perform(ByVal lngPrimeAccount As Long,_

    ByVal lngSecondAccount As Long, ByVal lngAmount _

    As Long, ByVal lngTranType As Long) As String

    Dim strResult As String

    On Error GoTo ErrorHandler

    ' create the account object using our context

    Dim objAccount As Bank.Account

    Set objAccount = _

        GetObjectContext.CreateInstance("Bank.Account")

    If objAccount Is Nothing Then

        Err.Raise ERROR_NUMBER, _

        Description:="Could not create account object"

    End If

    ' call the post function based on the

    ' transaction type

    Select Case lngTranType

        Case 1

            strResult = objAccount.Post(lngPrimeAccount, 0 - lngAmount)

            If strResult = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult

            End If

        Case 2

            strResult = objAccount.Post(lngPrimeAccount, lngAmount)

            If strResult = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult

            End If

        Case 3

            Dim strResult1 As String, strResult2 As String

            ' do the credit

            strResult1 = objAccount.Post(lngSecondAccount, lngAmount)

            If strResult1 = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult1

            Else

                ' then do the debit

                strResult2 = objAccount.Post(lngPrimeAccount, 0 - lngAmount)

                If strResult2 = "" Then

                ' debit failed

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult2

                Else

                    strResult = strResult1 + "  " + strResult2

                End If

            End If

        Case Else

            Err.Raise ERROR_NUMBER, _

                Description:="Invalid Transaction Type"

    End Select

    ' Get Receipt Number for the transaction

    Dim objReceiptNo As Bank.GetReceipt

    Dim lngReceiptNo As Long

    Set objReceiptNo = GetObjectContext.CreateInstance("Bank.GetReceipt")

    lngReceiptNo = objReceiptNo.GetNextReceipt

    If lngReceiptNo > 0 Then

        strResult = strResult & "; Receipt No: " _

            & Str$(lngReceiptNo)

    End If

    ' we are finished and happy

    GetObjectContext.SetComplete

    Perform = strResult

    Exit Function

ErrorHandler:

    GetObjectContext.SetAbort          ' we are unhappy

    Perform = ""       ' indicate that an error occured

    Err.Raise Err.Number, "Bank.MoveMoney.Perform", _

        Err.Description

End Function


StatefulPerform Method, Step6 (Visual Basic)

Public PrimeAccount As Long

Public SecondAccount As Long

Public Function StatefulPerform(ByVal lngAmount _

    As Long, ByVal lngTranType As Long) As String

    StatefulPerform = Perform(PrimeAccount, _

        SecondAccount, lngAmount, lngTranType)

End Function


Update Method, Step7 (Visual Basic)

Public Function Update() As Long

    On Error GoTo ErrorHandler

    ' get result set and then update table

    ' with new receipt number

    Dim adoConn As New ADODB.Connection

    Dim adoRsReceipt As ADODB.Recordset

    Dim lngNextReceipt As Long

    Dim strSQL As String

    strSQL = "Update Receipt set NextReceipt = NextReceipt + 100"

    adoConn.Open strConnect

    ' Assume that if there is an ado error then

    ' the receipt table does not exist

    On Error GoTo ErrorCreateTable

TryAgain:

    adoConn.Execute strSQL

    strSQL = "Select NextReceipt from Receipt"

    Set adoRsReceipt = adoConn.Execute(strSQL)

    lngNextReceipt = adoRsReceipt!NextReceipt

    Set adoConn = Nothing

    Set adoRsReceipt = Nothing

    ' we are finished and happy

    GetObjectContext.SetComplete

    Update = lngNextReceipt

    Exit Function

ErrorCreateTable:

    On Error GoTo ErrorHandler

    ' create the receipt table

    Dim objCreateTable As CreateTable

    Set objCreateTable = CreateObject("Bank.CreateTable")

    objCreateTable.CreateReceipt

    GoTo TryAgain

ErrorHandler:

    If Not adoConn Is Nothing Then

        Set adoConn = Nothing

    End If

    If Not adoRsReceipt Is Nothing Then

        Set adoRsReceipt = Nothing

    End If

    GetObjectContext.SetAbort      ' we are unhappy

    Update = -1        ' indicate that an error occured

    Err.Raise Err.Number, "Bank.UpdateReceipt.Update", Err.Description

End Function


GetNextReceipt Method, Step7 (Visual Basic)

Public Function GetNextReceipt() As Long

    On Error GoTo ErrorHandler

    ' If Shared property does not already exist

    ' it will be initialized

    Dim spmMgr As SharedPropertyGroupManager

    Set spmMgr = CreateObject("MTxSpm.SharedPropertyGroupManager.1")

    Dim spmGroup As SharedPropertyGroup

    Dim bResult As Boolean

    Set spmGroup = _

        spmMgr.CreatePropertyGroup("Receipt", _

        LockMethod, Process, bResult)

    Dim spmPropNextReceipt As SharedProperty

    Set spmPropNextReceipt = _

        spmGroup.CreateProperty("Next", bResult)

    ' Set the initial value of the Shared Property to

    ' 0 if the Shared Property didn’t already exist.

    ' This is not entirely necessary but demonstrates

    ' how to initialize a value.

    If bResult = False Then

        spmPropNextReceipt.Value = 0

    End If

    Dim spmPropMaxNum As SharedProperty

    Set spmPropMaxNum = spmGroup.CreateProperty("MaxNum", bResult)

    Dim objReceiptUpdate As Bank.UpdateReceipt

    If spmPropNextReceipt.Value >= spmPropMaxNum.Value Then

        Set objReceiptUpdate = GetObjectContext.CreateInstance("Bank.UpdateReceipt")

        spmPropNextReceipt.Value = objReceiptUpdate.Update

        spmPropMaxNum.Value = spmPropNextReceipt.Value + 100

    End If

    ' Get the next receipt number and update property

    spmPropNextReceipt.Value = spmPropNextReceipt.Value + 1

    ' we are finished and happy

    GetObjectContext.SetComplete

    GetNextReceipt = spmPropNextReceipt.Value

    Exit Function

ErrorHandler:

    GetObjectContext.SetAbort          ' we are unhappy

    ' indicate that an error occured

    GetNextReceipt = -1

    Err.Raise Err.Number, "Bank.GetReceipt.GetNextReceipt", Err.Description

End Function


Perform Method, Step8 (Visual Basic)

Public Function Perform(ByVal lngPrimeAccount As Long,_

    ByVal lngSecondAccount As Long, ByVal lngAmount _

    As Long, ByVal lngTranType As Long) As String

    Dim strResult As String

    On Error GoTo ErrorHandler

    ' check for security

    If (lngAmount > 500 Or lngAmount < -500) Then

        If Not GetObjectContext.IsCallerInRole("Managers") Then

            Err.Raise Number:=APP_ERROR, _

            Description:="Need 'Managers' role for amounts over $500"

        End If

    End If

    ' create the account object using our context

    Dim objAccount As Bank.Account

    Set objAccount = _

        GetObjectContext.CreateInstance("Bank.Account")

    If objAccount Is Nothing Then

        Err.Raise ERROR_NUMBER, _

        Description:="Could not create account object"

    End If

    ' call the post function based on the

    ' transaction type

    Select Case lngTranType

        Case 1

            strResult = objAccount.Post(lngPrimeAccount, 0 - lngAmount)

            If strResult = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult

            End If

        Case 2

            strResult = objAccount.Post(lngPrimeAccount, lngAmount)

            If strResult = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult

            End If

        Case 3

            Dim strResult1 As String, strResult2 As String

            ' do the credit

            strResult1 = objAccount.Post(lngSecondAccount, lngAmount)

            If strResult1 = "" Then

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult1

            Else

                ' then do the debit

                strResult2 = objAccount.Post(lngPrimeAccount, 0 - lngAmount)

                If strResult2 = "" Then

                ' debit failed

                Err.Raise ERROR_NUMBER, _

                    Description:=strResult2

                Else

                    strResult = strResult1 + "  " + strResult2

                End If

            End If

        Case Else

            Err.Raise ERROR_NUMBER, _

                Description:="Invalid Transaction Type"

    End Select

    ' Get Receipt Number for the transaction

    Dim objReceiptNo As Bank.GetReceipt

    Dim lngReceiptNo As Long

    Set objReceiptNo = GetObjectContext.CreateInstance("Bank.GetReceipt")

    lngReceiptNo = objReceiptNo.GetNextReceipt

    If lngReceiptNo > 0 Then

        strResult = strResult & "; Receipt No: " _

            & Str$(lngReceiptNo)

    End If

    ' we are finished and happy

    GetObjectContext.SetComplete

    Perform = strResult

    Exit Function

ErrorHandler:

    GetObjectContext.SetAbort          ' we are unhappy

    Perform = ""       ' indicate that an error occured

    Err.Raise Err.Number, "Bank.MoveMoney.Perform", _

        Err.Description

End Function


Post Method, Step8 (Visual Basic)

Public Function Post(ByVal lngAccountNo As Long, _

    ByVal lngAmount As Long) As String

    Dim strResult As String

    On Error GoTo ErrorHandler

    ' check for security

    If (lngAmount > 500 Or lngAmount < -500) Then

        If Not GetObjectContext.IsCallerInRole("Managers") Then

            Err.Raise Number:=APP_ERROR, _

            Description:="Need 'Managers' role for amounts over $500"

        End If

    End If

    ' obtain the ADO environment and connection

    Dim adoConn As New ADODB.Connection

    Dim varRows As Variant

    adoConn.Open strConnect

    On Error GoTo ErrorCreateTable

    ' update the balance

    Dim strSQL As String

    strSQL = "UPDATE Account SET Balance = Balance + "_

        + Str$(lngAmount) + " WHERE AccountNo = "

        + Str$(lngAccountNo)

TryAgain:

    adoConn.Execute strSQL, varRows

    ' if anything else happens

    On Error GoTo ErrorHandler

    ' get resulting balance which may have been

    ' further updated via triggers

    strSQL = "SELECT Balance FROM Account " _

        + "WHERE AccountNo = " + Str$(lngAccountNo)

    Dim adoRS As ADODB.Recordset

    Set adoRS = adoConn.Execute(strSQL)

    If adoRS.EOF Then

        Err.Raise Number:=APP_ERROR, _

            Description:="Error. Account " _

            + Str$(lngAccountNo) + " not on file."

    End If

    Dim lngBalance As Long

    lngBalance = adoRS.Fields("Balance").Value

    ' check if account is overdrawn

    If (lngBalance) < 0 Then

        Err.Raise Number:=APP_ERROR, _

            Description:="Error. Account " _

            + Str$(lngAccountNo) _

            + " would be overdrawn by " _

            + Str$(lngBalance) + ". Balance is still "

            + Str$(lngBalance - lngAmount) + "."

    Else

        If lngAmount < 0 Then

            strResult = strResult _

                & "Debit from account "

                & lngAccountNo & ", "

        Else

            strResult = strResult _

                & "Credit to account "

                & lngAccountNo & ", "

        End If

        strResult = strResult + "balance is $"

            & Str$(lngBalance) & ". (VB)"

    End If

    ' cleanup

    Set adoRS = Nothing

    Set adoConn = Nothing

    ' we are finished and happy

    GetObjectContext.SetComplete

    Post = strResult

Exit Function

ErrorCreateTable:

    On Error GoTo ErrorHandler

    ' create the account table

    Dim objCreateTable As CreateTable

    Set objCreateTable = _

    GetObjectContext.CreateInstance("Bank.CreateTable")

    objCreateTable.CreateAccount

    GoTo TryAgain

ErrorHandler:

    ' cleanup

    If Not adoRS Is Nothing Then

        Set adoRS = Nothing

    End If

    If Not adoConn Is Nothing Then

        Set adoConn = Nothing

    End If

    GetObjectContext.SetAbort          ' we are unhappy

    Post = ""         ' indicate that an error occurred

    Err.Raise Err.Number, "Bank.Accout.Post", _

        Err.Description

End Function


Создание нового объекта

Добавление объектов в окно Microsoft Transaction Server Explorer. Выполнение команды Создать определяется папкой, которая открыта в данное время в области справа. Например, если открыта папка «Компьютеры», вызов команды Создать добавляет новый компьютер.

Кнопка панели инструментов:

Дополнительные сведения о добавлении компьютера в папку «Компьютеры» содержатся в разделе Настройка сервера MTS.

Чтобы узнать, как создать новый пакет, см. раздел Создание пустого пакета MTS.

Чтобы узнать, как создать новую роль, см. раздел Добавление новой роли.


Крупные значки

Отображение объектов в правой области окна в виде крупных значков.

Кнопка панели инструментов:


Мелкие значки

Отображение объектов в правой области окна в виде мелких значков.

Кнопка панели инструментов:


Список

Отображение объектов в правой области окна в виде списка.

Кнопка панели инструментов:


Свойство

Отображение значений свойств объектов из выделенной в данное время папки. Свойства отображаются в виде таблицы в правой области окна Microsoft Transaction Server Explorer.

Кнопка панели инструментов:

Набор свойств зависит от типа выделенного объекта. В следующей таблице приводятся свойства, отображаемые для различных папок.

Папка	Свойства
Компьютеры	Имя  имя, которое было присвоено компьютеру и известно в домене Windows NT. Однако компьютер, на котором запущен Transaction Server, называется «Мой компьютер».
	Время ожидания
Установленные пакеты	Имя  имя, присвоенное пакету.
	Защита  указывает, была ли включена защита данного пакета.
	Проверка подлинности  уровень проверки аутентичности.
	Завершение работы  время, через которое пакет завершает работу при отсутствии активности.
	Всегда выполняется  указывает, что пакет не должен завершать работу при отсутствии активности.
	Учетная запись  учетная запись Windows NT, заданная для удостоверения пакета.
	Код пакета  универсальный уникальный идентификатор, присвоенный пакету.
Компоненты	Код программы  имя, которое было присвоено компоненту.
	Транзакция  указывает, поддерживает ли компонент транзакции.
	DLL
	CLSID
	Использует MTX  указывает, запускается ли в среде Transaction Server.
	Внутренний  указывает, что компонент выполняется в другом серверном процессе.
	Локальный  указывает, что компонент выполняется в серверном процессе на локальном компьютере.
	Удаленный  указывает, что компонент выполняется в серверном процессе на удаленном компьютере.
	Сервер  имя удаленного компьютера, на котором выполняется компонент.
	Поток  потоковая модель компонента.
	Защита  указывает, была ли включена защита данного компонента.
Роли	Имя  имя, присвоенное роли.
	Код роли  уникальный идентификатор, который был присвоен роли.
Интерфейсы	Имя  имя, присвоенное интерфейсу.
	Код интерфейса  уникальный идентификатор, который был присвоен интерфейсу.
	Proxy DLL
	Файл библиотеки типов  имя файла, который содержит библиотеку типов.
Методы	Имя  имя, присвоенное методу.
Используемые роли	Имя  имя, присвоенное роли, которая была добавлена для компонента или интерфейса.
	Код роли  уникальный идентификатор, который был присвоен роли.


Состояние

Отображение текущего состояния компонента или компьютера.

Кнопка панели инструментов:

Состояние компьютера

•	Имя  имя, присвоенное компьютеру.

•	DTC  указывает, была ли запущена служба MS DTC.

Состояние компонента

•	Код программы  имя, которое было присвоено компоненту.

•	Объектов  полное число объектов, которое было выделено в серверном процессе.

•	Активизировано  полное число объектов, которые используются клиентами.

•	Вызов  полное число объектов, которые в данное время выполняют вызов клиента.


Команда «Обновить» (меню «Вид»)

Обновление сведений, отображаемых в правой области окна Microsoft Transaction Server Explorer, вручную.

Кнопка панели инструментов:


Список терминов

автоматическая транзакция

администратор

активность

базовый клиент

базовый процесс

безопасная ссылка

библиотека динамической компоновки (DLL)

библиотека типов

библиотечный пакет

бизнес-правило

взаимоблокировка

внешний компонент процесса

внутренний компонент процесса

время ожидания транзакции

вызывающий клиент

глобальная учетная запись

готовый пакет

группа

группирование

декларативная безопасность

диспетчер ресурсов

диспетчер транзакций

долговечность

домен

замкнутый поток

значение Null

изолированность

изолированность процессов

изолированность сбоев

имя источника данных DSN (data source name)

имя пользователя

интерфейс

исключение

интерактивный пользователь

интерфейс ODBC (Open Database Connectivity)

исходный вызывающий клиент

исходный создатель объекта

каталог

класс

кластер

клиент

клиент/сервер

код класса CLSID

компонент

компонент Microsoft Transaction Server

конструктор

контекст

контекст транзакции

логическое значение (Boolean)

локальная учетная запись

метод

модель COM (Component Object Model)

несохраняющий объект

общее свойство

объект

объектная переменная

объект Microsoft Transaction Server

объект proxy

объект Snap-in

объект stub

одновременность

основной поток

отказоустойчивость

пакет

политика failfast

построение

поток

проверка подлинности

программный идентификатор (progID)

программная безопасность

протокол двухэтапного завершения транзакций

протокол XA

прямой вызывающий клиент

прямой создатель объекта

распределение загруженности

распределенная модель COM (DCOM)

распределитель ресурсов

распределитель ресурсов ODBC

репликация

роль

семафор

свойства контекстного объекта

серверный процесс

серверный пакет

служебная программа для исполняемого файла приложения

своевременная активизация

согласованность

создатель объекта

сообщение трассировки

сохраняющий объект

стандарт RPC (Remote Procedure Call)

строковое выражение

транзакция

транзакция в неопределенном состоянии

удаленный компонент

удостоверение

учетный код (SID)

фабрика классов

файл пакета

формирование параметров

целостность

экземпляр

ACID

ActiveX

Microsoft Distributed Transaction Coordinator (MS DTC)

Microsoft Transaction Server Explorer

OLE Transactions

Resource Dispenser Manager

ACID

Основные свойства транзакции: atomicity (целостность), consistency (согласованность), isolation (изолированность) и durability (долговечность).

ActiveX

Набор технологий, позволяющий компонентам программного обеспечения взаимодействовать друг с другом в сетевой среде, независимо от языка, на котором они были написаны. Технология ActiveX строится на основе модели COM (Component Object Model).

активность

Семейство объектов Microsoft Transaction Server, которые имеют единый распределенный логический поток выполнения. Каждый объект Microsoft Transaction Server принадлежит одной активности.

администратор

Пользователь, который использует среду Microsoft Transaction Server Explorer для установки и настройки компонентов и пакетов Microsoft Transaction Server, а также для управления ими.

построение

Метод построения объектов с применением составляющих объектов, когда новый объект может быть построен с помощью одного или нескольких существующих объектов, которые поддерживают некоторые или все требуемые новому объекту интерфейсы.

замкнутый поток

Поток, используемый для выполнения вызовов объектов из компонентов, настроенных для таких потоков. Каждый подобный объект все время своей жизни находится в «замкнутом пространстве» (потоке). Все вызовы такого объекта выполняются в замкнутом потоке. Такая потоковая модель используется, например, для реализаций компонентов, которые хранят состояние объекта в локальной памяти потока. Объекты компонента могут распределяться по одному или нескольким замкнутым пространствам. См. также основной поток.

служебная программа для исполняемого файла приложения

Средство MTS Explorer, позволяющее создавать исполняемый файл приложения с помощью экспорта пакета.

целостность

Характеристика транзакции, указывающая, что все действия транзакции были выполнены или не были выполнены.

проверка подлинности

Процесс определения удостоверения пользователя при его попытке получить доступ к системе. Например, для проверки подлинности пользователей обычно используются пароли.

автоматическая транзакция

Транзакция, которая создана для объекта в среде выполнения Microsoft Transaction Server на основе атрибутов транзакции компонента.

логическое значение (Boolean)

Значение True/False (Истина/Ложь) или Yes/No (Да/Нет).

базовый клиент

Клиент, который выполняется вне среды выполнения Microsoft Transaction Server, но который сопровождает объекты Microsoft Transaction Server.

базовый процесс

Процесс приложения, в котором выполняется базовый клиент. Базовый клиент выполняется вне среды выполнения Microsoft Transaction Server, но сопровождает объекты Microsoft Transaction Server.

бизнес-правило

Комбинация изменений прав доступа, проверок входа в систему, подстановок баз данных, политики и алгоритмических преобразований, которые составляют способ работы предприятия. Иногда это называют бизнес-логикой.

вызывающий клиент

Клиент, вызывающий метод объекта. Вызывающий клиент не обязательно является создателем объекта. Например клиент A создал объект X и передал на него ссылку клиенту B, а затем клиент B использовал эту ссылку для вызова метода объекта X. В данном случае клиент A является создателем объекта, а клиент B — вызывающим клиентом. См. также создатель объекта.

каталог

Хранилище данных Microsoft Transaction Server, которое содержит сведения о конфигурации для компонентов, пакетов и ролей. Имеется возможность администрировать каталог с помощью среды Microsoft Transaction Server Explorer.

класс

Тип, определяющий интерфейсы определенного типа объекта. Класс определяет свойства объекта и методы, используемые для управления поведением объекта.

фабрика классов

Объект, реализующий интерфейс IClassFactory, который позволяет ему создавать объекты специфического класса.

код класса CLSID

Универсальный уникальный идентификатор, который определяет компонент COM. Каждый компонент COM имеет свой код CLSID в реестре Windows, чтобы его можно было загрузить в любом приложении.

клиент

Приложение или процесс, запрашивающий обслуживание у некоторого процесса или компонента.

клиент/сервер

Модель распределенных приложений, в которой клиентские приложения запрашивают обслуживание у серверных приложений. Сервер может одновременно иметь много клиентов, а клиент может запрашивать данные с нескольких серверов. Приложение может быть сразу и клиентом, и сервером.

кластер

Две или более независимых компьютерных систем, которые адресуются и управляются как единая система с помощью Microsoft Cluster Server.

модель COM (Component Object Model)

Открытая архитектура для кросс-платформной разработки клиент/серверных приложений, основанных на объектно-ориентированной технологии. Клиенты имеют доступ к объекту через интерфейс, реализованный на этом объекте. Модель COM не зависит от языка, поэтому любой язык, используемый для создания компонентов ActiveX, позволяет создавать приложения COM.

компонент

Дискретная единица программы, встроенная в технологию ActiveX, которая предоставляет заданный набор служб через определенные интерфейсы. Компоненты предоставляют объекты, запрашиваемые клиентами во время выполнения.

одновременность

Вид одновременного выполнения процессов или транзакций путем выполнения различных частей работы с чередованием.

согласованность

Состояние, при котором данные длительного хранения соответствуют состоянию, ожидаемому изменяющим эти данные бизнес-правилом.

конструктор

В C++ и Java, специальная функция инициализации, которая автоматически вызывается при описании экземпляра класса. Она препятствует возникновению ошибок использования неинициализированных объектов. Конструктор имеет то же имя, что и класс, но не может возвращать значения.

контекст

Состояние, которое неявно связывается с данным объектом Microsoft Transaction Server. Контекст содержит сведения о среде выполнения объекта, например удостоверение создателя объекта, и, иногда, транзакции, окружающие работу объекта. Контекст объекта подобен по идее контексту процесса, который операционная система поддерживает для выполняющейся программы. Среда выполнения Microsoft Transaction Server управляет контекстом для каждого объекта.

свойства контекстного объекта

Свойства, которые могут быть получены из контекстного объекта, например внутренние объекты Internet Information Server.

создатель объекта

Клиент, который создает объект, предоставленный компонентом (с помощью метода CreateObject, CoCreateInstance или CreateInstance). Когда клиент создает объект, ему дается название, с помощью которого можно вызывать методы данного объекта. См. также вызывающий клиент.

имя источника данных DSN (data source name)

Имя, которое приложение использует для запроса подключения к источнику данных ODBC.

взаимоблокировка

Ситуация, в которой два или более потоков постоянно блокированы (находятся в состоянии ожидания), причем каждый поток ожидает ресурсы, монопольно удерживаемые одним из других блокированных потоков. Например, если поток A блокирует запись 1 и предполагает блокировать запись 2, пока поток B блокирует запись 2 и предполагает блокировать запись 1, эти два потока находятся в состоянии взаимоблокировки.

декларативная безопасность

Безопасность, настроенная с помощью Microsoft Transaction Server Explorer. Имеется возможность управлять доступом к пакетам, компонентам и экземплярам с помощью определения ролей. Роли определяют пользователей, которым разрешено вызывать интерфейсы компонента. См. также программная безопасность.

прямой вызывающий клиент

Удостоверение процесса (базового клиента или серверного процесса), вызывающего текущий серверный процесс.

прямой создатель объекта

Удостоверение процесса (базового клиента или серверного процесса), который непосредственно создал текущий объект.

распределенная модель COM (DCOM)

DCOM представляет собой протокол объектов, который позволяет компонентам ActiveX напрямую взаимодействовать друг с другом через сеть. Модель DCOM не зависит от языка, поэтому любой язык, используемый для создания компонентов ActiveX, позволяет создавать приложения DCOM.

домен

Семейство компьютеров Windows NT, определенных администратором сети сервера Windows NT, которые совместно используют общую базу данных каталога. Домен предоставляет централизованный доступ к учетным записям пользователей и групп, обслуживаемых администратором домена. Каждый домен имеет уникальное имя.

долговечность

Свойство, характеризующее способность преодолевать неполадки.

библиотека динамической компоновки (DLL)

Файл, содержащий одну или несколько функций, которые были скомпилированы, скомпонованы и сохранены отдельно от использующих их процессов. Операционная система отображает библиотеки динамической компоновки на адресное пространство вызывающего процесса, когда процесс запускается или выполняется.

исключение

Необычное состояние или ошибка, происходящая во время выполнения программы и требующая выполнения программного обеспечения за пределами обычной последовательности команд.

политика failfast

Политика Microsoft Transaction Server, которая упрощает устранение возникновения сбоев. Когда сервер транзакций непредвиденно обнаруживает состояние внутренней ошибки, он немедленно завершает выполнение процесса и записывает сообщение со сведениями о сбое в журнал событий Windows NT.

изолированность сбоев

Сохранение результатов сбоя внутри компонента, вместо их распространения по другим компонентам системы.

отказоустойчивость

Способность системы восстанавливаться после ошибок, сбоев или изменений в условиях внешней среды (например отключения питания). Истинная отказоустойчивость обеспечивает полностью автоматическое восстановление без повреждения задач или файлов пользователей. Напротив, отказоустойчивость, обеспечиваемая вручную, означает восстановление потерянных данных с помощью архивных файлов.

глобальная учетная запись

Обычная учетная запись пользователя в его основном домене. Большинство учетных записей являются глобальными учетными записями, которые создаются по умолчанию. Если имеется доступ к нескольким доменам, лучше, чтобы каждый пользователь в сети имел не более одной глобальной учетной записи в единственном домене.

группа

Имя, определяющее набор из одной или нескольких учетных записей пользователей Windows NT.

удостоверение

Свойство пакета, указывающее учетные записи пользователей, которым разрешен доступ к пакету. Это может быть учетная запись определенного пользователя или группы пользователей домена Windows NT.

транзакция в неопределенном состоянии

Транзакция, которая была подготовлена, но не было решено завершить или отменить ее, поскольку координирующий транзакцию сервер недоступен.

внутренний компонент процесса

Компонент, выполняемый внутри пространства процесса клиента. Обычно это библиотека динамической компоновки (DLL).

экземпляр

Объект определенного класса компонента. Каждый экземпляр имеет свои личные элементы данных или переменные компонентов. Экземпляр компонента является синонимом объекта.

интерактивный пользователь

Пользователь, вошедший в данное время в компьютер Windows сервера транзакций.

интерфейс

Группа логически связанных операций или методов, которые обеспечивают доступ к компонентному объекту.

изолированность

Характеристика транзакций, когда две работающие параллельно транзакции создают иллюзию, что они выполняются одновременно. На самом деле система одновременно выполняет только одну транзакцию.

своевременная активизация

Способность объекта Microsoft Transaction Server активизироваться для выполнения запросов клиентов только в нужный момент. Объекты могут быть отключены, даже если клиенты имеют на них ссылки, позволяя разгружать ресурсы сервера для более эффективного использования.

библиотечный пакет

Пакет, выполняемый в процессе клиента, который его создал. Библиотечные пакеты не поддерживают отслеживание компонентов, проверку ролей и изолированность процессов. MTS поддерживает два типа пакетов: библиотечные пакеты и серверные пакеты.

распределение загруженности

Распределение загрузки процессов между несколькими серверами, выполняющими сетевые задачи, для увеличения общего быстродействия сети.

локальная учетная запись

Учетная запись, предоставляемая в локальном домене пользователю, обычная учетная запись которого не содержится в домене, с которым установлены доверительные отношения. Локальные учетные записи не могут быть использованы для интерактивного входа в систему. Локальные учетные записи, созданные в одном домене, не могут быть использованы в доменах, с которыми установлены доверительные отношения.

основной поток

Единый поток, используемый для выполнения всех объектов компонентов, отмеченных соответствующей меткой. См. также замкнутый поток.

формирование параметров

Процесс упаковки и отправки параметров метода интерфейса за границы потока или процесса.

метод

Процедура (функция), выполняемая над объектом.

Microsoft Distributed Transaction Coordinator (MS DTC)

Диспетчер транзакций, который координирует транзакции, распределяемые между несколькими диспетчерами ресурсов. Работа может быть выполнена как единая транзакция даже в том случае, когда она распределяется между несколькими диспетчерами ресурсов, в том числе и на разных компьютерах.

компонент Microsoft Transaction Server

Компонент модели COM, который выполняется в среде выполнения Microsoft Transaction Server. Компонент сервера транзакций должен быть библиотекой динамической компоновки (DLL), которая применяет для создания объектов библиотеку классов и описывает все интерфейсы компонентов в библиотеке типов для стандартного формирования параметров.

Microsoft Transaction Server Explorer

Приложение для настройки компонентов Microsoft Transaction Server и управления ими в распределенной сети компьютеров.

объект Microsoft Transaction Server

Объект COM, выполняемый в среде выполнения Microsoft Transaction Server и следующий модели программирования и развертывания Transaction Server.

значение Null

Значение, которое указывает на отсутствие или неизвестные данные.

объект

Исполняемый экземпляр компонента COM. Объект создается фабрикой классов компонента. Объект является синонимом экземпляра.

объектная переменная

Переменная, содержащая ссылку на объект.

распределитель ресурсов ODBC

Распределитель ресурсов, который управляет группами подключений к базам данных для компонентов Microsoft Transaction Server, использующих стандартные интерфейсы программирования ODBC.

протокол OLE Transactions

Объектно-ориентированный протокол двухэтапного завершения транзакций, основанный на модели COM (Component Object Model). Он используется диспетчерами ресурсов для участия в распределенных транзакциях, координируемых Microsoft Distributed Transaction Coordinator (DTC).

интерфейс ODBC (Open Database Connectivity)

Стандартный интерфейс языков программирования, используемый для подключения к различным источникам данных.

исходный вызывающий клиент

Удостоверение базового клиента, который инициировал активность.

исходный создатель объекта

Удостоверение базового клиента, который создал текущий объект. Исходный вызывающий клиент и исходный создатель объекта отличаются только в том случае, если исходный создатель объекта передал объект другому базовому клиенту. См. также исходный вызывающий клиент.

внешний компонент процесса

Компонент, который выполняется в пространстве процессов, отличном от пространства своего клиента. Microsoft Transaction Server позволяет компонентам, реализованным как библиотеки динамической компоновки, использоваться за пределами процессов клиента, загружая их в отдельные серверные процессы.

пакет

Набор компонентов, выполняющих связанные функции приложения. Все компоненты пакета выполняются вместе в одном и том же серверном процессе Microsoft Transaction Server. Пакет является границей доверительных отношений, которая определяет проверку учетных сведений для обеспечения безопасности, а также источников развертывания набора компонентов. Пакеты создаются с помощью Transaction Server Explorer. Пакеты бывают библиотечными или серверными.

файл пакета

Файл, содержащий сведения о компонентах и ролях пакета. Файл пакета создается с помощью функции экспорта пакетов из Transaction Server Explorer. При создании готовых пакетов связанные файлы компонентов (библиотеки динамической компоновки (DLL), библиотеки типов и библиотеки динамической компоновки proxy-stub, если имеются) копируются в тот же каталог, в котором был создан файл пакета.

группирование

Оптимизация быстродействия, основанная на использовании семейства заранее выделенных ресурсов, таких как объекты или подключения к базам данных. Группирование позволяет выделить ресурсы более эффективным способом.

готовый пакет

Файл пакета, который содержит сведения о компонентах и ролях пакета. Файл пакета создается с помощью функции экспорта пакетов из Transaction Server Explorer. При создании готовых пакетов связанные файлы компонентов (библиотеки динамической компоновки (DLL), библиотеки типов и библиотеки динамической компоновки proxy-stub, если имеются) копируются в тот же каталог, в котором был создан файл пакета.

изолированность процессов

Метод выполнения серверного процесса в отдельном пространстве памяти, чтобы изолировать этот процесс от других серверных процессов. Изолированность процесса защищает серверный процесс от других неустранимых ошибок приложения. Изолированность серверного процесса предотвращает также остановку другого серверного процесса при неустранимой ошибке данного изолированного процесса. Пакет MTS, который поддерживает изолированность процессов, называется серверным пакетом.

программный идентификатор (progID)

Имя, которое определяет компонент COM. Например программным идентификатором может быть выражение Bank.MoveMoney.

программная безопасность

Процедурная логика, предоставляемая компонентом для определения проверки прав клиента на выполнение требуемой операции. См. также декларативная безопасность.

объект proxy

Специфический интерфейсный объект, обеспечивающий формирование параметров и связь, требуемые клиенту для вызова объекта application, выполняемого в другой среде выполнения, например в другом потоке или процессе. Объект proxy находится на клиенте и связывается с соответствующим объектом stub, размещаемом в вызываемом объекте application.

удаленный компонент

Компонент, используемый клиентом на другом компьютере.

стандарт RPC (Remote Procedure Call)

Стандарт, который позволяет одному процессу вызывать функции, выполняемые в другом процессе. Процесс может выполняться как на том же компьютере, так и на другом компьютере в сети.

репликация

Операция копирования каталога с одного компьютера на другой. Репликация используется для синхронизации серверов MTS в кластере.

распределитель ресурсов

Служба, обеспечивающая синхронизацию недолговечных ресурсов и управление ими внутри процесса для простого и эффективного совместного использования объектов Microsoft Transaction Server. Например распределитель ресурсов ODBC управляет группами подключений к базам данных.

Resource Dispenser Manager

Библиотека динамической компоновки, которая координирует работу в семействе распределителей ресурсов.

диспетчер ресурсов

Системная служба, осуществляющая управление данными длительного хранения. Приложения серверов используют диспетчер ресурсов для поддержки состояния сохраняемых в приложении данных, таких как записи о складских запасах, ожидаемых заказах и дебиторской задолженности. Чтобы обеспечить для приложения гарантию целостности и изолированности, диспетчеры ресурсов работают совместно с диспетчером транзакций (с использованием протокола двухэтапного завершения транзакций). Примером диспетчера ресурсов является Microsoft SQL Server.

роль

Символическое имя, определяющее класс пользователей набора компонентов. Каждая роль определяет пользователей, которым разрешено вызывать интерфейсы компонента.

безопасная ссылка

Ссылка на текущий объект, которую можно безопасно передавать за пределы контекста текущего объекта.

учетный код (SID)

Уникальное имя, определяющее вошедшего в систему пользователя для системы безопасности. Коды SID могут определять одного пользователя или группу пользователей.

семафор

Механизм блокировки, используемый внутри диспетчеров или распределителей ресурсов. Семафоры не имеют символических имен, доступны только в совместном и монопольном режиме, в них отсутствует средство определения взаимоблокировки, а также средства автоматического освобождения или завершения.

серверный пакет

Пакет, выполняемый изолированно в своем собственном процессе на локальном компьютере. Серверные пакеты поддерживают безопасность на основе ролей, предоставление совместного доступа к ресурсам, изолированность процессов и управление процессами (например отслеживанием пакетов). MTS поддерживает два типа пакетов: библиотечные и серверные пакеты.

серверный процесс

Процесс, содержащий компоненты Microsoft Transaction Server.

Компонент Microsoft Transaction Server может быть загружен в суррогатный серверный процесс на компьютере клиента или в процесс приложения клиента.

общее свойство

Переменная, которая доступна всем объектам в одном и том же серверном процессе с помощью диспетчера общих свойств (Shared Property Manager). Значение свойства имеет любой тип, который может быть представлен с помощью типа Variant.

объект snap-in

Административная программа, используемая в Microsoft Management Console (MMC). MTS Explorer в Windows NT является объектом snap-in.

сохраняющий объект

Объект, сохраняющий личное состояние, вытекающее из выполнения одного или нескольких клиентских вызовов.

несохраняющий объект

Объект, не сохраняющий личное состояние, вытекающее из выполнения одного или нескольких клиентских вызовов.

строковое выражение

Любое выражение, преобразуемое в непрерывную последовательность символов.

объект stub

Специфический интерфейсный объект, обеспечивающий формирование параметров и связь, требуемые клиенту для вызова объекта-приложения, выполняемого в другой среде выполнения, например в другом потоке или процессе. Объект stub находится в объекте-приложении и связывается с соответствующим объектом proxy, который размещается на вызывающем клиенте.

поток

Основная сущность, на которую операционная система выделяет процессорное время. Поток может выполнять любую часть кода приложения, включая часть, выполняемую в данное время другим потоком. Все потоки процесса используют общее виртуальное адресное пространство, глобальные переменные и ресурсы операционной системы процесса.

транзакция

Совокупность действий, которые выполняются в рамках единой операции, которая либо успешно выполняется в целом, либо не выполняется.

контекст транзакции

Объект, разрешающий клиенту динамически включить один или несколько объектов в одну транзакцию.

диспетчер транзакций

Системная служба, ответственная за координацию результатов транзакций для достижения целостности. Диспетчер транзакций гарантирует принятие диспетчерами ресурсов согласованных решений на предмет выполнения или отмены транзакции.

сообщение трассировки

Сообщение, которое включает текущее состояние различных активностей Microsoft Transaction Server, например загрузки и завершения работы.

время ожидания транзакции

Максимальный период времени, в течение которого транзакция может оставаться активной, прежде чем она будет автоматически прервана диспетчером транзакций.

библиотека типов

Файл, содержащий стандартные описания типов данных, модулей и интерфейсов, которые могут быть использованы для полного представления объектов с помощью технологии ActiveX.

протокол двухэтапного завершения транзакций

Протокол, который гарантирует, что транзакции, применяемые на нескольких серверах, будут завершены либо на всех серверах, либо ни на одном из них. Такое завершение транзакций координируется диспетчером транзакций и поддерживается диспетчерами ресурсов.

имя пользователя

Имя, определяющее учетную запись пользователя Windows NT.

протокол XA

Протокол двухэтапного завершения транзакций, определенный группой X/Open DTP. Протокол XA внутренне поддерживается многими базами данных Unix, включая Informix, Oracle и DB2.