IDataCollector

XML を使用してコレクターのプロパティを設定および取得し、ログファイル名を指定し、ログファイルの場所を取得します。このインターフェイスは抽象クラスであり、次のデータコレクターの派生元です:IAlertDataCollectorIApiTracingDataCollectorIConfigurationDataCollectorIPerformanceCounterDataCollectorITraceDataCollector

派生データコレクターのいずれかを作成するために IDataCollectorCollection::CreateDataCollectorFromXml プロパティを呼び出す場合、次の例に示す XML を使用してこのオブジェクトを初期化できます。IDataCollector::Xml プロパティもこの XML を返します。

    <FileName/>
    <FileNameFormat/>
    <FileNameFormatPattern/>
    <Index/>
    <LatestOutputLocation/>
    <LogAppend/>
    <LogCircular/>
    <LogOverwrite/>
    <Name/>
    <OutputLocation/>

この例では派生データコレクターのプロパティ要素を示していないことに注意してください(各データコレクターの XML 要素については、それぞれのデータコレクターを参照してください)。これらの要素は、必要に応じてデータコレクターの XML に含めてください。次の例は、アラートデータコレクターの XML を示しています。要素は任意の順序で指定できます。

<AlertDataCollector>
    <FileName/>
    <FileNameFormat/>
    <FileNameFormatPattern/>
    <Index/>
    <LatestOutputLocation/>
    <LogAppend/>
    <LogCircular/>
    <LogOverwrite/>
    <Name/>
    <OutputLocation/>
    <Alert/>  <!-- 各アラートに対して <Alert> 要素を指定します -->
    <EventLog/>
    <SampleInterval/>
    <Task/>
    <TaskArguments/>
    <TaskUserTextArguments/>
    <TaskSetWorkingDirectory/>
    <TriggerDataCollectorSet/>
</AlertDataCollector>

コレクターを作成する XML を指定するとき、設定したいプロパティの要素だけを指定できます。プロパティを指定しない場合、PLA は既定値を提供します。コレクターの XML を取得すると、その XML には IDataCollector のものを含むすべての要素が含まれます。

このデータコレクターが属するデータコレクターセットを取得します。

このデータコレクターの種類(例:パフォーマンスデータコレクター)を取得します。

PLA は、データコレクターを作成するときに種類を設定します。

データコレクターのデータを格納するファイルのベース名を取得または設定します。(Get)

IDataCollector::FileNameFormat プロパティで書式設定オプションを指定した場合、実際に使用されるファイル名は異なることがあります。実際に使用されたファイル名は IDataCollector::LatestOutputLocation プロパティに格納されます。

ファイル名にパスを含めないでください。ファイルへのパスは IDataCollectorSet::RootPath プロパティと IDataCollectorSet::Subdirectory プロパティによって決まります。

指定するファイル名拡張子は、データコレクターの種類によって異なります。次の表は、各データコレクターで使用する正しい拡張子を示しています。別の拡張子を指定した場合、PLA はそれを使用します。拡張子を指定しない場合、PLA はファイルに正しい拡張子を追加します。

ファイルが既に存在する場合に実行される処理は、IDataCollector::LogAppend プロパティと IDataCollector::LogOverwrite プロパティによって決まります。

データコレクターのデータを格納するファイルのベース名を取得または設定します。(Put)

IDataCollector::FileNameFormat プロパティで書式設定オプションを指定した場合、実際に使用されるファイル名は異なることがあります。実際に使用されたファイル名は IDataCollector::LatestOutputLocation プロパティに格納されます。

ファイル名にパスを含めないでください。ファイルへのパスは IDataCollectorSet::RootPath プロパティと IDataCollectorSet::Subdirectory プロパティによって決まります。

指定するファイル名拡張子は、データコレクターの種類によって異なります。次の表は、各データコレクターで使用する正しい拡張子を示しています。別の拡張子を指定した場合、PLA はそれを使用します。拡張子を指定しない場合、PLA はファイルに正しい拡張子を追加します。

ファイルが既に存在する場合に実行される処理は、IDataCollector::LogAppend プロパティと IDataCollector::LogOverwrite プロパティによって決まります。

ファイル名を装飾する方法を記述するフラグを取得または設定します。(Get)

PLA はファイル名に装飾を追加します。たとえば plaMonthDayHour を指定すると、PLA は現在の月、日、時の値をファイル名に追加します。ファイル名が MyFile の場合、結果は MyFile110816 のようになります。

ファイル名を装飾する方法を記述するフラグを取得または設定します。(Put)

PLA はファイル名に装飾を追加します。たとえば plaMonthDayHour を指定すると、PLA は現在の月、日、時の値をファイル名に追加します。ファイル名が MyFile の場合、結果は MyFile110816 のようになります。

ファイル名を装飾するときに使用する書式パターンを取得または設定します。(Get)

PLA は、IDataCollector::FileNameFormat プロパティが plaPattern に設定されている場合にのみ、このパターンを使用します。

PLA はファイル名に装飾を追加します。次のパターン文字を使用して独自のパターンを定義します。たとえば、パターン "MMMM d, yyyy \a\t h:mmTt" は "January 31, 2005 at 4:20AM" を生成することがあります。ファイル名が MyFile の場合、装飾されたファイル名は "MyFile January 31, 2005 at 4:20AM" になります。

ファイル名を装飾するときに使用する書式パターンを取得または設定します。(Put)

PLA は、IDataCollector::FileNameFormat プロパティが plaPattern に設定されている場合にのみ、このパターンを使用します。

PLA はファイル名に装飾を追加します。次のパターン文字を使用して独自のパターンを定義します。たとえば、パターン "MMMM d, yyyy \a\t h:mmTt" は "January 31, 2005 at 4:20AM" を生成することがあります。ファイル名が MyFile の場合、装飾されたファイル名は "MyFile January 31, 2005 at 4:20AM" になります。

PLA が前回ファイルを作成したときに使用した、完全に装飾されたファイル名を取得または設定します。(IDataCollector.get_LatestOutputLocation)

通常、このプロパティは設定しません。データコレクターが開始すると、PLA は IDataCollector::OutputLocation プロパティの値を使用してこのプロパティを設定します。

ファイルが削除された場合は、このプロパティを空に設定できます。

トレースデータコレクターの場合に限り、このプロパティに使用するファイルの名前を設定できます。設定しない場合、PLA は他のデータコレクターと同様にファイルを作成します。

PLA が前回ファイルを作成したときに使用した、完全に装飾されたファイル名を取得または設定します。(IDataCollector.put_LatestOutputLocation)

通常、このプロパティは設定しません。データコレクターが開始すると、PLA は IDataCollector::OutputLocation プロパティの値を使用してこのプロパティを設定します。

ファイルが削除された場合は、このプロパティを空に設定できます。

トレースデータコレクターの場合に限り、このプロパティに使用するファイルの名前を設定できます。設定しない場合、PLA は他のデータコレクターと同様にファイルを作成します。

収集したデータを現在のファイルに追加するかどうかを示す値を取得または設定します。(Get)

このプロパティが IDataCollector::LogCircular プロパティまたは IDataCollector::LogOverwrite プロパティと競合する場合、検証エラーが発生します。

収集したデータを現在のファイルに追加するかどうかを示す値を取得または設定します。(Put)

このプロパティが IDataCollector::LogCircular プロパティまたは IDataCollector::LogOverwrite プロパティと競合する場合、検証エラーが発生します。

循環ファイルを作成するかどうかを示す値を取得または設定します。(Get)

循環ファイルを作成するかどうかを示す値を取得または設定します。(Put)

現在のファイルを上書きするかどうかを示す値を取得または設定します。(Get)

現在のファイルを上書きするかどうかを示す値を取得または設定します。(Put)

データコレクターの名前を取得または設定します。(Get)

データコレクターの名前を取得または設定します。(Put)

PLA が今ファイルを作成するとした場合の、装飾されたファイル名を取得します。

IDataCollector::LatestOutputLocation プロパティには、コレクターが前回実行されたときに使用された装飾済みのファイル名が格納されます。

データコレクターのインデックス値を取得します。インデックス値は、データコレクターセット内でデータコレクターを識別します。

PLA は、データコレクターをデータコレクターセットに追加するときにインデックス値を設定します。

データコレクターのプロパティの値を記述する XML 文字列を取得します。

XML 文字列に含まれるプロパティ要素の詳細については、IDataCollector の「解説」セクションを参照してください。

XML に含まれるプロパティのプロパティ値を設定します。(IDataCollector.SetXml)

メソッドの呼び出しが成功した場合は S_OK を返します。値マップにエラーがないか確認する必要があります。メソッドが S_OK を返し、検証エラーがない場合、コレクターは正常に初期化されています。

XML の構文が有効であれば、1 つ以上のプロパティが無効であっても、この API は S_OK を返します。値が有効なプロパティは設定されます。値が無効なプロパティは既定値に設定されます。

データコレクターを作成するときに XML を IDataCollectorCollection::CreateDataCollectorFromXml プロパティに渡すことでも、コレクターのプロパティを初期化できます。

XML で指定されたコレクター要素がインターフェイスのコレクターの種類と一致しない場合、このメソッドは失敗します。

発生したエラーを特定するには、各エラーの IValueMapItem インターフェイスを取得します。IValueMapItem::Key プロパティにはエラーが発生した要素の XPath(例:/AlertDataCollector/TaskArguments)が、IValueMapItem::Value プロパティにはエラーに関連付けられた HRESULT が、IValueMapItem::Description プロパティにはエラーに関連付けられたメッセージテキストが格納されます。

通常、発生するエラーは次の HRESULT 値のいずれかになります。