IProfile
クライアントが制御するプロファイルを表します。 インターフェイスには、ファイルまたは文字列から XML 形式でプロファイルを読み込む関数が用意されています。 クライアントは、Event Tracing for Windows (ETW) プロバイダーを追加または削除することで、ユーザーがプロファイルの更新を許可されるかどうかを決定できます。
構文
{
typedef enum
{
LoggingMode_Unknown,
LoggingMode_Memory,
LoggingMode_File,
}
CLoggingMode;
typedef enum
{
DetailLevel_Unknown,
DetailLevel_Light,
DetailLevel_Verbose,
}
CDetailLevel;
[propget, id(1), helpstring("IsMutable")] HRESULT IsMutable
([out, retval] VARIANT_BOOL* pfMutable);
[propput, id(1), helpstring("IsMutable")] HRESULT IsMutable
([in] VARIANT_BOOL fMutable); [propget, id(2), helpstring("Version")] HRESULT Version
([out, retval] float* pVersion);
[propget, id(3), helpstring("Author")] HRESULT Author
([out, retval] BSTR* pbstrAuthor);
[propget, id(4), helpstring("Team")] HRESULT Team
([out, retval] BSTR* pbstrTeam);
[propget, id(5), helpstring("Comments")] HRESULT Comments
([out, retval] BSTR* pbstrComments);
[propget, id(6), helpstring("Company")] HRESULT Company
([out, retval] BSTR* pbstrCompany);
[propget, id(7), helpstring("Copyright")] HRESULT Copyright
([out, retval] BSTR* pbstrCopyright);
[propget, id(8), helpstring("Tag")] HRESULT Tag
([out, retval] BSTR* pbstrTag);
[propget, id(9), helpstring("Id")] HRESULT Id
([out, retval] BSTR* pbstrId);
[propget, id(10), helpstring("Name")] HRESULT Name
([out, retval] BSTR* pbstrName);
[propget, id(11), helpstring("Description")] HRESULT Description
([out, retval] BSTR* pbstrDescription);
[propget, id(12), helpstring("LoggingMode")] HRESULT LoggingMode
([out, retval] CLoggingMode* pLoggingMode);
[propget, id(13), helpstring("LoggingModeString")] HRESULT LoggingModeString
([out, retval] BSTR* pbstrLoggingMode);
[propget, id(14), helpstring("DetailLevel")] HRESULT DetailLevel
([out, retval] CDetailLevel* pDetailLevel);
[propget, id(15), helpstring("DetailLevelString")] HRESULT DetailLevelString
([out, retval] BSTR* pbstrDetailLevel);
[propget, id(16), helpstring("IsStrict")] HRESULT IsStrict
([out, retval] VARIANT_BOOL* pfStrict);
[propget, id(17), helpstring("IsDefault")] HRESULT IsDefault
([out, retval] VARIANT_BOOL* pfDefault);
[propget, id(18), helpstring("ProblemCategories")] HRESULT ProblemCategories
([out, retval] BSTR* pbstrProblemCategories);
[id(19), helpstring("LoadFromFile")] HRESULT LoadFromFile
([in] BSTR bstrProfileName,
[in] BSTR bstrFileName);
[id(20), helpstring("LoadFromString")] HRESULT LoadFromString
([in] BSTR bstrProfile);
[id(21), helpstring("IsEqual")] HRESULT IsEqual
([in] IProfile* pProfile);};
関数
次の表では、このインターフェイスで提供される関数について説明します。
機能 | 説明 |
---|---|
propget |
指定したプロパティの値を返します。 |
propput |
指定されたプロパティを設定します。 |
指定されたファイルからプロファイルを読み込みます。 |
|
指定された XML プロファイル定義文字列からプロファイルを読み込みます。 |
|
2 つの IProfile オブジェクトを比較します。 |
Properties
このインターフェイスは、次の表で説明するプロパティを提供します。
プロパティ | パラメーター | 説明 |
---|---|---|
IsMutable |
pfMutable |
[out] 同じ名前のプロファイルが IProfileCollection::Add メソッドで組み合わされている場合に、セッションとプロバイダーを既存のプロファイルに追加できることを示すブール値を返します。 S_OK は成功を示します。 |
IsMutable |
fMutable |
[in] セッションとプロバイダーをプロファイルに追加できるかどうかを示すブール値。 S_OK は成功を示します。 |
Version |
pVersion |
[out] プロファイルのバージョンを示します。 |
作成者 |
pbstrAuthor |
[out] プロファイルの作成者を示します。 |
チーム |
pbstrTeam |
[out] プロファイルを作成したチームを示します。 |
コメント |
pbstrComments |
[out] プロファイルに関するオプションのコメント。 |
Company |
pbstrCompany |
[out] プロファイルを作成した会社を示します。 |
著作権 |
pbstrCopyright |
[out]プロファイルに関連する著作権情報を示します。 |
Tag |
pbstrTag |
[out] プロファイルを区別するために使用できる、オプションのタグ付けされた値。 |
Id |
pbstrId |
[out] プロファイルの識別子を示します。 |
名前 |
pbstrName |
[out] プロファイルの名前を示します。 |
説明 |
pbstrDescription |
[out] プロファイルの説明を示します。 |
LoggingMode |
pLoggingMode |
[out] ログ モードを示します。 |
LoggingModeString |
pbstrLoggingMode |
[out] ログ モード文字列を示します。 指定できる値は、"memory" と "file" です。 |
DetailLevel |
pDetailLevel |
[out] 詳細レベルを示します。 |
DetailLevelString |
pbstrDetailLevel |
[out] 詳細レベル文字列を示します。 指定できる値は "verbose" と "light" です。 |
IsStrict |
pfStrict |
[out] コレクターまたはプロバイダーの起動に失敗した場合に記録をロールバックするかどうかを示すブール値。 |
IsDefault |
pfDefault |
[out] これが既定のプロファイルであるかどうかを示すブール値。 |
ProblemCategories |
pbstrProblemCategories |
[out] このプロファイルが検出するように設計されている問題を示します。 |