Win32 API 日本語リファレンス
ホームDevices.Fax › IFaxSecurity

IFaxSecurity

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID77b508c1-09c0-47a2-91eb-fce7fdf2690e継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxSecurity 構成オブジェクトは、FAX クライアントアプリケーションが FAX サーバーのセキュリティを構成するために使用し、呼び出し元アプリケーションが FAX サーバーのセキュリティ記述子を設定および取得できるようにします。

解説(Remarks)

FAX サーバーのセキュリティを構成できるのは、権限を持つ管理者のみです。詳細については、アクセス制御を参照してください。

IFaxSecurity の既定の実装は、FaxSecurity オブジェクトとして提供されます。

メソッド 7

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_Descriptor(VARIANT* pvDescriptor)

Descriptor プロパティは、IFaxServer オブジェクトのセキュリティ記述子を表します。(Get)

pvDescriptorVARIANT*outセキュリティ記述子(SDDL/バイナリ)を格納したVARIANTを受け取る出力先。

解説(Remarks)

IFaxSecurity::Descriptor プロパティは、FAX 管理者によってユーザーに明示的に付与された権限を含むセキュリティ記述子を表します。IFaxSecurity::get_GrantedRights プロパティは、この記述子に基づいて FAX サーバーが付与するユーザー権限を反映します。具体的には、ユーザーがアクセス権 farSUBMIT_HIGH を持つ場合、そのユーザーは高優先度、通常優先度、および低優先度の FAX を送信できます。ユーザーがアクセス権 farSUBMIT_NORMAL を持つ場合、そのユーザーは通常優先度および低優先度の FAX を送信できます。

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 8 HRESULT put_Descriptor(VARIANT vDescriptor)

Descriptor プロパティは、IFaxServer オブジェクトのセキュリティ記述子を表します。(Put)

vDescriptorVARIANTin設定するセキュリティ記述子を格納したVARIANT。

解説(Remarks)

IFaxSecurity::Descriptor プロパティは、FAX 管理者によってユーザーに明示的に付与された権限を含むセキュリティ記述子を表します。IFaxSecurity::get_GrantedRights プロパティは、この記述子に基づいて FAX サーバーが付与するユーザー権限を反映します。具体的には、ユーザーがアクセス権 farSUBMIT_HIGH を持つ場合、そのユーザーは高優先度、通常優先度、および低優先度の FAX を送信できます。ユーザーがアクセス権 farSUBMIT_NORMAL を持つ場合、そのユーザーは通常優先度および低優先度の FAX を送信できます。

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 9 HRESULT get_GrantedRights(FAX_ACCESS_RIGHTS_ENUM* pGrantedRights)

IFaxSecurity::get_GrantedRights プロパティは、このプロパティを参照するユーザーに付与された FAX サーバーのアクセス権の組み合わせです。

pGrantedRightsFAX_ACCESS_RIGHTS_ENUM*out呼び出し元に付与されたアクセス権FAX_ACCESS_RIGHTS_ENUMを受け取る出力先。

解説(Remarks)

IFaxSecurity::get_GrantedRights プロパティは FAX サーバーによって付与された権限を反映するのに対し、IFaxSecurity::Descriptor プロパティは、FAX 管理者によってユーザーに明示的に付与された権限を含むセキュリティ記述子を表します。

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 10 HRESULT Refresh()

IFaxSecurity::Refresh メソッドは、FaxSecurity オブジェクトの情報を FAX サーバーから更新します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

解説(Remarks)

IFaxSecurity::Refresh メソッドを呼び出すと、最後に IFaxSecurity::Save メソッドを呼び出した後に行われた構成の変更はすべて失われます。

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 11 HRESULT Save()

IFaxSecurity::Save メソッドは、FaxSecurity オブジェクトのデータを保存します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG および farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 12 HRESULT get_InformationType(INT* plInformationType)

IFaxSecurity::InformationType プロパティは、セキュリティ情報の種類を表します。(Get)

plInformationTypeINT*out取得対象のセキュリティ情報種別を表す値を受け取る出力先。

解説(Remarks)

情報の種類はビット単位の組み合わせで、IFaxSecurity::Descriptor プロパティを使用してセキュリティ記述子を要求するとき、または IFaxSecurity::Refresh メソッドを使用して IFaxSecurity オブジェクトを更新するときに、サーバーからどのセキュリティ情報を取得するかを示します。また、情報の種類は、IFaxSecurity::Save メソッドを使用して IFaxSecurity オブジェクトへの変更を保存するときに、FAX サーバーへ送信される情報も決定します。

これらのビットは、Winnt.h で定義されている SECURITY_INFORMATION 構造体で指定されます。セキュリティ情報の各項目はビットフラグで指定されます。次の値は、FAX サービスに適用されるビットを示します。

意味
DACL_SECURITY_INFORMATION オブジェクトの随意アクセス制御リスト (ACL) が参照されることを示します。
GROUP_SECURITY_INFORMATION オブジェクトのプライマリグループ識別子が参照されることを示します。
OWNER_SECURITY_INFORMATION オブジェクトの所有者識別子が参照されることを示します。
SACL_SECURITY_INFORMATION オブジェクトのシステム ACL が参照されることを示します。

IFaxSecurity::get_Descriptor メソッドを呼び出す前に IFaxSecurity::InformationType プロパティを設定して、必要な情報を確実に受け取れるようにし、かつ適切なアクセス権を持つ情報のみを要求するようにしてください。また、IFaxSecurity::InformationType プロパティは、IFaxSecurity::Save メソッドを呼び出したときに FAX サーバーへ送信される情報にも影響します。IFaxSecurity::InformationType プロパティを設定しない場合、既定では DACL_SECURITY_INFORMATIONGROUP_SECURITY_INFORMATION、および OWNER_SECURITY_INFORMATION の各フラグになります。

vtbl 13 HRESULT put_InformationType(INT lInformationType)

IFaxSecurity::InformationType プロパティは、セキュリティ情報の種類を表します。(Put)

lInformationTypeINTin設定対象のセキュリティ情報種別を指定する値。

解説(Remarks)

情報の種類はビット単位の組み合わせで、IFaxSecurity::Descriptor プロパティを使用してセキュリティ記述子を要求するとき、または IFaxSecurity::Refresh メソッドを使用して IFaxSecurity オブジェクトを更新するときに、サーバーからどのセキュリティ情報を取得するかを示します。また、情報の種類は、IFaxSecurity::Save メソッドを使用して IFaxSecurity オブジェクトへの変更を保存するときに、FAX サーバーへ送信される情報も決定します。

これらのビットは、Winnt.h で定義されている SECURITY_INFORMATION 構造体で指定されます。セキュリティ情報の各項目はビットフラグで指定されます。次の値は、FAX サービスに適用されるビットを示します。

意味
DACL_SECURITY_INFORMATION オブジェクトの随意アクセス制御リスト (ACL) が参照されることを示します。
GROUP_SECURITY_INFORMATION オブジェクトのプライマリグループ識別子が参照されることを示します。
OWNER_SECURITY_INFORMATION オブジェクトの所有者識別子が参照されることを示します。
SACL_SECURITY_INFORMATION オブジェクトのシステム ACL が参照されることを示します。

IFaxSecurity::get_Descriptor メソッドを呼び出す前に IFaxSecurity::InformationType プロパティを設定して、必要な情報を確実に受け取れるようにし、かつ適切なアクセス権を持つ情報のみを要求するようにしてください。また、IFaxSecurity::InformationType プロパティは、IFaxSecurity::Save メソッドを呼び出したときに FAX サーバーへ送信される情報にも影響します。IFaxSecurity::InformationType プロパティを設定しない場合、既定では DACL_SECURITY_INFORMATIONGROUP_SECURITY_INFORMATION、および OWNER_SECURITY_INFORMATION の各フラグになります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IFaxSecurity "{77B508C1-09C0-47A2-91EB-FCE7FDF2690E}"
#usecom global IFaxSecurity IID_IFaxSecurity "{}"
#comfunc global IFaxSecurity_get_Descriptor       7 var
#comfunc global IFaxSecurity_put_Descriptor       8 int
#comfunc global IFaxSecurity_get_GrantedRights    9 var
#comfunc global IFaxSecurity_Refresh              10
#comfunc global IFaxSecurity_Save                 11
#comfunc global IFaxSecurity_get_InformationType  12 var
#comfunc global IFaxSecurity_put_InformationType  13 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。