Win32 API 日本語リファレンス
ホーム › Storage.Xps › IXpsOMPath

IXpsOMPath

COM
📘 Microsoft Learn (日本語) · English
IID37d38bb6-3ee9-4110-9312-14b194163337継承元IXpsOMVisual自前メソッド開始 vtbl30

公式ドキュメント

テキスト以外の視覚的な項目を表します。

解説(Remarks)

次のコード例は、このインターフェイスのインスタンスを作成する方法を示しています。


IXpsOMPath    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreatePath (&newInterface);

    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

メソッド 37

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 30 HRESULT GetGeometry(IXpsOMGeometry** geometry)

このパスの解決済みの塗りつぶし領域を表す、パスの IXpsOMGeometry インターフェイスへのポインターを取得します。

geometryIXpsOMGeometry**out

このパスの解決済みの塗りつぶし領域を表す、パスの IXpsOMGeometry インターフェイスへのポインター。ジオメトリが設定されていない場合は、NULL ポインターが返されます。

このパラメーターで返される値は、ジオメトリを設定するために直前に呼び出されたメソッドによって異なります。

直前に呼び出されたメソッド geometry に返されるオブジェクト

SetGeometryLocal

 SetGeometryLocal で設定されたローカル ジオメトリ。

SetGeometryLookup

 SetGeometryLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ジオメトリ。
SetGeometryLocal と SetGeometryLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 geometry が NULL です。
XPS_E_LOOKUP_INVALID_TYPE
 SetStrokeBrushLookup で設定されたルックアップ キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND
 ルックアップ値と一致するキー名を持つオブジェクトが見つかりませんでした。
vtbl 31 HRESULT GetGeometryLocal(IXpsOMGeometry** geometry)

このパスの解決済みの塗りつぶし領域の、ローカルで共有されないジオメトリを取得します。

geometryIXpsOMGeometry**out

このパスの解決済みの塗りつぶし領域の、ローカルで共有されないジオメトリ。ジオメトリのルックアップ キーが設定されている場合、またはローカル ジオメトリが設定されていない場合は、NULL ポインターが返されます。

直前に呼び出されたメソッド geometry に返されるオブジェクト

SetGeometryLocal

 SetGeometryLocal で設定されたローカル ジオメトリ。

SetGeometryLookup

 NULL ポインター。
SetGeometryLocal と SetGeometryLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 geometry が NULL です。
vtbl 32 HRESULT SetGeometryLocal(IXpsOMGeometry* geometry)

このパスに設定する解決済みの塗りつぶし領域のジオメトリを保持する、ローカルで共有されない IXpsOMGeometry インターフェイスへのポインターを設定します。

geometryIXpsOMGeometry*inこのパスに設定する解決済みの塗りつぶし領域のジオメトリを保持する、ローカルで共有されない IXpsOMGeometry インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
XPS_E_NO_CUSTOM_OBJECTS
 geometry が、認識されるインターフェイス実装を指していません。XPS ドキュメント API のインターフェイスを独自に実装することはサポートされていません。

解説(Remarks)

SetGeometryLocal を呼び出すと、ジオメトリのルックアップ キーは解放され、GetGeometryLookup は lookup パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

直前に呼び出されたメソッド GetGeometry が geometry に返すオブジェクト GetGeometryLocal が geometry に返すオブジェクト GetGeometryLookup が lookup に返す文字列
SetGeometryLocal (このメソッド) SetGeometryLocal で設定されたローカル ジオメトリ。 SetGeometryLocal で設定されたローカル ジオメトリ。 NULL ポインター。

SetGeometryLookup

 SetGeometryLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ジオメトリ。 NULL ポインター。 SetGeometryLookup で設定されたルックアップ キー。
SetGeometryLocal と SetGeometryLookup のいずれもまだ呼び出されていない。 NULL ポインター。 NULL ポインター。 NULL ポインター。
vtbl 33 HRESULT GetGeometryLookup(LPWSTR* lookup)

リソース ディクショナリに格納され、このパスの解決済みの塗りつぶし領域を表す共有ジオメトリ オブジェクトのルックアップ キーを取得します。

lookupLPWSTR*out

このパスの解決済みの塗りつぶし領域を表すジオメトリ オブジェクトのルックアップ キー。ジオメトリのルックアップ キーが設定されていない場合、またはローカル ジオメトリが設定されている場合は、NULL ポインターが返されます。

直前に呼び出されたメソッド lookup に返される文字列

SetGeometryLocal

 NULL ポインター。

SetGeometryLookup

 SetGeometryLookup で設定されたルックアップ キー。
SetGeometryLocal と SetGeometryLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 lookup が NULL です。

解説(Remarks)

このメソッドは、lookup で返される文字列が使用するメモリを割り当てます。lookup が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 34 HRESULT SetGeometryLookup(LPWSTR lookup)

リソース ディクショナリ内の共有ジオメトリのルックアップ キー名を設定します。

lookupLPWSTRinリソース ディクショナリ内の共有ジオメトリのルックアップ キー名。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
XPS_E_INVALID_RESOURCE_KEY
 XML Paper Specification に照らして、lookup の値が有効なルックアップ キー文字列ではありません。
XPS_E_INVALID_LOOKUP_TYPE
 lookup のルックアップ キー名が、ジオメトリではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND
 lookup に渡された値と一致するキー名を持つオブジェクトが見つかりませんでした。

解説(Remarks)

SetGeometryLookup を呼び出すと、ローカル ジオメトリは解放され、SetGeometryLocal は geometry パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

直前に呼び出されたメソッド GetGeometry が geometry に返すオブジェクト GetGeometryLocal が geometry に返すオブジェクト GetGeometryLookup が lookup に返す文字列

SetGeometryLocal

 SetGeometryLocal で設定されたローカル ジオメトリ。 SetGeometryLocal で設定されたローカル ジオメトリ。 NULL ポインター。
SetGeometryLookup (このメソッド) SetGeometryLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ジオメトリ。 NULL ポインター。 SetGeometryLookup で設定されたルックアップ キー。
SetGeometryLocal と SetGeometryLookup のいずれもまだ呼び出されていない。 NULL ポインター。 NULL ポインター。 NULL ポインター。
vtbl 35 HRESULT GetAccessibilityShortDescription(LPWSTR* shortDescription)

オブジェクトの内容に関する短いテキストの説明を取得します。

shortDescriptionLPWSTR*outオブジェクトの内容に関する短いテキストの説明。この説明が設定されていない場合は、NULL ポインターが返されます。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 shortDescription が NULL です。

解説(Remarks)

shortDescription で返される値は、ドキュメント マークアップ内の Path 要素の AutomationProperties.Name 属性の値です。

このメソッドは、shortDescription で返される文字列が使用するメモリを割り当てます。shortDescription が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 36 HRESULT SetAccessibilityShortDescription(LPWSTR shortDescription)

オブジェクトの内容に関する短いテキストの説明を設定します。(IXpsOMPath.SetAccessibilityShortDescription)

shortDescriptionLPWSTRinオブジェクトの内容に関する短いテキストの説明。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ドキュメント マークアップでは、shortDescription に設定した値が Path 要素の AutomationProperties.Name 属性の値になります。

vtbl 37 HRESULT GetAccessibilityLongDescription(LPWSTR* longDescription)

オブジェクトの内容に関する長い (詳細な) テキストの説明を取得します。(IXpsOMPath.GetAccessibilityLongDescription)

longDescriptionLPWSTR*outオブジェクトの内容に関する詳細なテキストの説明。この説明が設定されていない場合は、NULL ポインターが返されます。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 longDescription が NULL です。

解説(Remarks)

longDescription で返される値は、ドキュメント マークアップ内の Path 要素の AutomationProperties.HelpText 属性の値です。

このメソッドは、longDescription で返される文字列が使用するメモリを割り当てます。longDescription が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 38 HRESULT SetAccessibilityLongDescription(LPWSTR longDescription)

オブジェクトの内容に関する長い (詳細な) テキストの説明を設定します。(IXpsOMPath.SetAccessibilityLongDescription)

longDescriptionLPWSTRinオブジェクトの内容に関する詳細なテキストの説明。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ドキュメント マークアップでは、longDescription に設定した値が Path 要素の AutomationProperties.HelpText 属性の値になります。

vtbl 39 HRESULT GetSnapsToPixels(BOOL* snapsToPixels)

パスのレンダリング時に、パスをデバイス ピクセルにスナップするかどうかを示すブール値を取得します。

snapsToPixelsBOOL*out

パスのレンダリング時に、パスをデバイス ピクセルにスナップするかどうかを示すブール値。このパラメーターに指定できる値を次の表に示します。

値 意味
TRUE
 パスをデバイス ピクセルにスナップします。
FALSE
 パスをデバイス ピクセルにスナップしません。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 snapsToPixels が NULL です。

解説(Remarks)

GetSnapsToPixels が返す値は、ドキュメント マークアップ内の SnapsToDevicePixels 要素に対応します。

vtbl 40 HRESULT SetSnapsToPixels(BOOL snapsToPixels)

パスのレンダリング時に、そのパスをデバイス ピクセルにスナップするかどうかを示すブール値を設定します。

snapsToPixelsBOOLin

パスのレンダリング時に、そのパスをデバイス ピクセルにスナップするかどうかを示すブール値。このパラメーターに指定できる値を次の表に示します。

値 意味
TRUE
 パスをデバイス ピクセルにスナップします。
FALSE
 パスをデバイス ピクセルにスナップしません。

戻り値

メソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 41 HRESULT GetStrokeBrush(IXpsOMBrush** brush)

パスに設定されているストローク ブラシを保持する、解決済みの IXpsOMBrush インターフェイスへのポインターを取得します。

brushIXpsOMBrush**out

パスに設定されているストローク ブラシ。ストローク ブラシが設定されていない場合は、NULL ポインターが返されます。

このパラメーターで返される値は、ブラシを設定するために直前に呼び出されたメソッドによって異なります。

直前に呼び出されたメソッド brush に返されるオブジェクト

SetStrokeBrushLocal

 SetStrokeBrushLocal で設定されたローカル ブラシ。

SetStrokeBrushLookup

 SetStrokeBrushLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ブラシ。
SetStrokeBrushLocal と SetStrokeBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 brush が NULL です。
XPS_E_LOOKUP_INVALID_TYPE
 SetStrokeBrushLookup で設定されたルックアップ キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND
 ルックアップ値と一致するキー名を持つオブジェクトが見つかりませんでした。
vtbl 42 HRESULT GetStrokeBrushLocal(IXpsOMBrush** brush)

パスのストローク ブラシを保持する、ローカルで共有されない IXpsOMBrush インターフェイスへのポインターを取得します。

brushIXpsOMBrush**out

パスのストローク ブラシを保持する、ローカルで共有されない IXpsOMBrush インターフェイス。ストローク ブラシのルックアップ キーが設定されている場合、またはローカルのストローク ブラシが設定されていない場合は、NULL ポインターが返されます。

直前に呼び出されたメソッド brush に返されるオブジェクト

SetStrokeBrushLocal

 SetStrokeBrushLocal で設定されたローカル ブラシ。

SetStrokeBrushLookup

 NULL ポインター。
SetStrokeBrushLocal と SetStrokeBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 brush が NULL です。
vtbl 43 HRESULT SetStrokeBrushLocal(IXpsOMBrush* brush)

ストローク ブラシとして使用する、ローカルで共有されない IXpsOMBrush インターフェイスへのポインターを設定します。

brushIXpsOMBrush*inストローク ブラシとして使用する、ローカルで共有されない IXpsOMBrush インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
XPS_E_NO_CUSTOM_OBJECTS
 brush が、認識されるインターフェイス実装を指していません。XPS ドキュメント API のインターフェイスを独自に実装することはサポートされていません。

解説(Remarks)

SetStrokeBrushLocal を呼び出すと、ストローク ブラシのルックアップ キーは解放され、GetStrokeBrushLookup は lookup パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

直前に呼び出されたメソッド GetStrokeBrush が brush に返すオブジェクト GetStrokeBrushLocal が brush に返すオブジェクト GetStrokeBrushLookup が lookup に返す文字列
SetStrokeBrushLocal (このメソッド) SetStrokeBrushLocal で設定されたローカル ブラシ。 SetStrokeBrushLocal で設定されたローカル ブラシ。 NULL ポインター。

SetStrokeBrushLookup

 SetStrokeBrushLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ブラシ。 NULL ポインター。 SetStrokeBrushLookup で設定されたルックアップ キー。
SetStrokeBrushLocal と SetStrokeBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。 NULL ポインター。 NULL ポインター。
vtbl 44 HRESULT GetStrokeBrushLookup(LPWSTR* lookup)

リソース ディクショナリに格納され、パスのストローク ブラシとして使用されるブラシのルックアップ キーを取得します。

lookupLPWSTR*out

リソース ディクショナリに格納されているブラシのルックアップ キー。ストローク ブラシのルックアップ キーが設定されていない場合、またはローカルのストローク ブラシが設定されている場合は、NULL ポインターが返されます。

直前に呼び出されたメソッド lookup に返される文字列

SetStrokeBrushLocal

 NULL ポインター。

SetStrokeBrushLookup

 SetStrokeBrushLookup で設定されたルックアップ キー。
SetStrokeBrushLocal と SetStrokeBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 lookup が NULL です。

解説(Remarks)

このメソッドは、lookup で返される文字列が使用するメモリを割り当てます。lookup が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 45 HRESULT SetStrokeBrushLookup(LPWSTR lookup)

ストローク ブラシとして使用する共有ブラシのルックアップ キー名を設定します。

lookupLPWSTRinパスのストローク ブラシとして使用する共有ブラシのルックアップ キー名。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
XPS_E_INVALID_RESOURCE_KEY
 XML Paper Specification に照らして、lookup の値が有効なルックアップ キー文字列ではありません。
XPS_E_INVALID_LOOKUP_TYPE
 lookup のルックアップ キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND
 lookup に渡された値と一致するキー名を持つオブジェクトが見つかりませんでした。

解説(Remarks)

SetStrokeBrushLookup を呼び出すと、ローカルのストローク ブラシは解放され、GetStrokeBrushLocal は brush パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

直前に呼び出されたメソッド GetStrokeBrush が brush に返すオブジェクト GetStrokeBrushLocal が brush に返すオブジェクト GetStrokeBrushLookup が lookup に返す文字列

SetStrokeBrushLocal

 SetStrokeBrushLocal で設定されたローカル ブラシ。 SetStrokeBrushLocal で設定されたローカル ブラシ。 NULL ポインター。
SetStrokeBrushLookup (このメソッド) SetStrokeBrushLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ブラシ。 NULL ポインター。 SetStrokeBrushLookup で設定されたルックアップ キー。
SetStrokeBrushLocal と SetStrokeBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。 NULL ポインター。 NULL ポインター。
vtbl 46 HRESULT GetStrokeDashes(IXpsOMDashCollection** strokeDashes)

ストロークの破線パターンを定義する XPS_DASH 構造体を保持する IXpsOMDashCollection インターフェイスへのポインターを取得します。

strokeDashesIXpsOMDashCollection**outストロークの破線パターンを定義する XPS_DASH 構造体を保持する IXpsOMDashCollection インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeDashes が NULL です。
vtbl 47 HRESULT GetStrokeDashCap(XPS_DASH_CAP* strokeDashCap)

ストロークの破線に使用する終端キャップのスタイルを取得します。

strokeDashCapXPS_DASH_CAP*outストロークの破線に使用する終端キャップのスタイルを表す XPS_DASH_CAP 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeDashCap が NULL です。

解説(Remarks)

破線キャップのスタイルの詳細については、XPS_DASH_CAP を参照してください。

vtbl 48 HRESULT SetStrokeDashCap(XPS_DASH_CAP strokeDashCap)

ストロークの破線キャップのスタイルを設定します。

strokeDashCapXPS_DASH_CAPin設定する XPS_DASH_CAP 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
strokeDashCap が有効な XPS_DASH_CAP 値ではありませんでした。

解説(Remarks)

破線キャップのスタイルの詳細については、XPS_DASH_CAP を参照してください。

vtbl 49 HRESULT GetStrokeDashOffset(FLOAT* strokeDashOffset)

ストロークの原点から破線配列パターンの開始点までのオフセットを取得します。

strokeDashOffsetFLOAT*outオフセット値。ストロークの太さの倍数で指定します。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeDashOffset が NULL です。
vtbl 50 HRESULT SetStrokeDashOffset(FLOAT strokeDashOffset)

ストロークの原点から破線配列パターンの開始点までのオフセットを設定します。

strokeDashOffsetFLOATin設定するオフセット値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 strokeDashOffset が有効なオフセット値ではありません。

解説(Remarks)

オフセットは、ストロークの原点から破線が開始する位置までの距離を表し、ストロークの太さの倍数で指定します。

vtbl 51 HRESULT GetStrokeStartLineCap(XPS_LINE_CAP* strokeStartLineCap)

ストローク線の始点における線キャップのスタイルを取得します。

strokeStartLineCapXPS_LINE_CAP*outストローク線の始点における線キャップのスタイルを示す XPS_LINE_CAP 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeStartLineCap が NULL です。

解説(Remarks)

線キャップの形状の詳細については、XPS_LINE_CAP を参照してください。

vtbl 52 HRESULT SetStrokeStartLineCap(XPS_LINE_CAP strokeStartLineCap)

ストローク線の始点におけるストロークの線キャップのスタイルを設定します。

strokeStartLineCapXPS_LINE_CAPin設定する XPS_LINE_CAP 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
strokeStartLineCap が有効な XPS_LINE_CAP 値ではありません。

解説(Remarks)

線の結合スタイルの詳細については、XPS_LINE_CAP を参照してください。

vtbl 53 HRESULT GetStrokeEndLineCap(XPS_LINE_CAP* strokeEndLineCap)

ストローク線の終端キャップのスタイルを取得します。

strokeEndLineCapXPS_LINE_CAP*outストローク線の終端キャップのスタイルを指定する XPS_LINE_CAP 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeEndLineCap が NULL です。

解説(Remarks)

線の終端キャップのスタイルの詳細については、XPS_LINE_CAP を参照してください。

vtbl 54 HRESULT SetStrokeEndLineCap(XPS_LINE_CAP strokeEndLineCap)

ストローク線の終端キャップのスタイルを設定します。

strokeEndLineCapXPS_LINE_CAPin設定する XPS_LINE_CAP 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
strokeEndLineCap が有効な XPS_LINE_CAP 値ではありません。

解説(Remarks)

破線キャップのスタイルの詳細については、XPS_LINE_CAP を参照してください。

vtbl 55 HRESULT GetStrokeLineJoin(XPS_LINE_JOIN* strokeLineJoin)

ストローク線を結合するスタイルを取得します。

strokeLineJoinXPS_LINE_JOIN*outストロークの線の結合スタイルを表す XPS_LINE_JOIN 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeLineJoin が NULL です。

解説(Remarks)

線の結合スタイルの詳細については、XPS_LINE_JOIN を参照してください。

vtbl 56 HRESULT SetStrokeLineJoin(XPS_LINE_JOIN strokeLineJoin)

ストローク線を結合するスタイルを設定します。

strokeLineJoinXPS_LINE_JOINin設定する XPS_LINE_JOIN 値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
strokeLineJoin が有効な XPS_LINE_JOIN 値ではありません。

解説(Remarks)

線の結合スタイルの詳細については、XPS_LINE_JOIN を参照してください。

vtbl 57 HRESULT GetStrokeMiterLimit(FLOAT* strokeMiterLimit)

ストロークに設定されているマイター制限値を取得します。

strokeMiterLimitFLOAT*outストロークに設定されているマイター制限値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeMiterLimit が NULL です。

解説(Remarks)

マイター制限値は、最大マイター長とストロークの太さの半分との比率です。

マイター制限値は、マイター結合をどのようにレンダリングするかを表します。この値は、線の結合スタイルの値が XPS_LINE_JOIN_MITER の場合にのみ適用されます。

vtbl 58 HRESULT SetStrokeMiterLimit(FLOAT strokeMiterLimit)

パスのマイター制限を設定します。

strokeMiterLimitFLOATin設定するマイター制限値。値は 1.0 以上である必要があります。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 strokeMiterLimit に渡された値が無効でした。

解説(Remarks)

マイター制限値は、最大マイター長とストロークの太さの半分との比率です。

マイター制限値は、マイター結合をどのようにレンダリングするかを表します。この値は、線の結合スタイルの値が XPS_LINE_JOIN_MITER の場合にのみ適用されます。

vtbl 59 HRESULT GetStrokeThickness(FLOAT* strokeThickness)

ストロークの太さを取得します。

strokeThicknessFLOAT*outストロークの太さの値。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 strokeStartLineCap が NULL です。

解説(Remarks)

strokeThickness で返される値は、有効な座標空間の単位でストロークの太さを指定します。この単位にはパスのレンダリング変換が含まれます。

ストロークはパスのジオメトリの境界線上に描画され、ストロークの幅の半分がパスに指定されたジオメトリの外側に、残りの半分が内側に収まります。

vtbl 60 HRESULT SetStrokeThickness(FLOAT strokeThickness)

ストロークの太さを設定します。

strokeThicknessFLOATin設定するストロークの太さの値。0.0 以上である必要があります。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_INVALIDARG
 strokeThickness に渡された値が無効でした。

解説(Remarks)

strokeThickness で返される値は、有効な座標空間の単位でストロークの太さを指定します。この単位にはパスのレンダリング変換が含まれます。

ストロークはパスのジオメトリの境界線上に描画され、ストロークの幅の半分がパスに指定されたジオメトリの外側に、残りの半分が内側に収まります。

vtbl 61 HRESULT GetFillBrush(IXpsOMBrush** brush)

パスの塗りつぶしブラシを保持する、解決済みの IXpsOMBrush インターフェイスへのポインターを取得します。

brushIXpsOMBrush**out

パスの塗りつぶしブラシを保持する、解決済みの IXpsOMBrush インターフェイスへのポインター。塗りつぶしブラシが設定されていない場合は、NULL ポインターが返されます。

このパラメーターで返される値は、ブラシを設定するために直前に呼び出されたメソッドによって異なります。

直前に呼び出されたメソッド brush に返されるオブジェクト

SetFillBrushLocal

 SetFillBrushLocal で設定されたローカル ブラシ。

SetFillBrushLookup

 SetFillBrushLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ブラシ。
SetFillBrushLocal と SetFillBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 brush が NULL です。
XPS_E_LOOKUP_INVALID_TYPE
 SetStrokeBrushLookup で設定されたルックアップ キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND
 ルックアップ値と一致するキー名を持つオブジェクトが見つかりませんでした。
vtbl 62 HRESULT GetFillBrushLocal(IXpsOMBrush** brush)

パスの塗りつぶしブラシを保持する、ローカルで共有されない IXpsOMBrush インターフェイスへのポインターを取得します。

brushIXpsOMBrush**out

パスのローカルで共有されない塗りつぶしブラシとして使用する IXpsOMBrush インターフェイスへのポインター。塗りつぶしブラシのルックアップ キーが設定されている場合、またはローカルの塗りつぶしブラシが設定されていない場合は、NULL ポインターが返されます。

このパラメーターで返される値は、ブラシを設定するために直前に呼び出されたメソッドによって異なります。

直前に呼び出されたメソッド brush に返されるオブジェクト

SetFillBrushLocal

 SetFillBrushLocal で設定されたローカル ブラシ。

SetFillBrushLookup

 NULL ポインター。
SetFillBrushLocal と SetFillBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 brush が NULL です。
vtbl 63 HRESULT SetFillBrushLocal(IXpsOMBrush* brush)

塗りつぶしブラシとして使用する、ローカルで共有されない IXpsOMBrush インターフェイスへのポインターを設定します。

brushIXpsOMBrush*in塗りつぶしブラシとして使用する、ローカルで共有されない IXpsOMBrush インターフェイスへのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
XPS_E_NO_CUSTOM_OBJECTS
 brush が、認識されるインターフェイス実装を指していません。XPS ドキュメント API のインターフェイスを独自に実装することはサポートされていません。

解説(Remarks)

SetFillBrushLocal を呼び出すと、塗りつぶしブラシのルックアップ キーは解放され、GetFillBrushLookup は lookup パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

直前に呼び出されたメソッド GetFillBrush が brush に返すオブジェクト GetFillBrushLocal が brush に返すオブジェクト GetFillBrushLookup が lookup に返す文字列
SetFillBrushLocal (このメソッド) SetFillBrushLocal で設定されたローカル ブラシ。 SetFillBrushLocal で設定されたローカル ブラシ。 NULL ポインター。

SetFillBrushLookup

 SetFillBrushLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ブラシ。 NULL ポインター。 SetFillBrushLookup で設定されたルックアップ キー。
SetFillBrushLocal と SetFillBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。 NULL ポインター。 NULL ポインター。
vtbl 64 HRESULT GetFillBrushLookup(LPWSTR* lookup)

リソース ディクショナリに格納され、パスの塗りつぶしブラシとして使用されるブラシのルックアップ キーを取得します。

lookupLPWSTR*out

リソース ディクショナリに格納されている塗りつぶしブラシのルックアップ キー。ルックアップ キーが設定されていない場合、またはローカルの塗りつぶしブラシが設定されている場合は、NULL ポインターが返されます。

直前に呼び出されたメソッド lookup に返される文字列

SetFillBrushLocal

 NULL ポインター。

SetFillBrushLookup

 SetFillBrushLookup で設定されたルックアップ キー。
SetFillBrushLocal と SetFillBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_POINTER
 lookup が NULL です。

解説(Remarks)

このメソッドは、lookup で返される文字列が使用するメモリを割り当てます。lookup が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放してください。

vtbl 65 HRESULT SetFillBrushLookup(LPWSTR lookup)

塗りつぶしブラシとして使用する、リソース ディクショナリ内の共有ブラシのルックアップ キー名を設定します。

lookupLPWSTRin塗りつぶしブラシとして使用する、リソース ディクショナリ内のブラシのキー名。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
XPS_E_INVALID_RESOURCE_KEY
 XML Paper Specification に照らして、lookup の値が有効なルックアップ キー文字列ではありません。
XPS_E_INVALID_LOOKUP_TYPE
 lookup のルックアップ キー名が、ブラシではないオブジェクトを参照しています。
XPS_E_LOOKUP_NOT_FOUND
 lookup に渡された値と一致するキー名を持つオブジェクトが見つかりませんでした。

解説(Remarks)

SetFillBrushLookup を呼び出すと、ローカルの塗りつぶしブラシは解放され、GetFillBrushLocal は brush パラメーターに NULL ポインターを返します。次の表は、このプロパティのローカル値とルックアップ値の関係を示しています。

直前に呼び出されたメソッド GetFillBrush が brush に返すオブジェクト GetFillBrushLocal が brush に返すオブジェクト GetFillBrushLookup が lookup に返す文字列

SetFillBrushLocal

 SetFillBrushLocal で設定されたローカル ブラシ。 SetFillBrushLocal で設定されたローカル ブラシ。 NULL ポインター。
SetFillBrushLookup (このメソッド) SetFillBrushLookup で設定されたキーと一致するルックアップ キーで、リソース ディレクトリから取得された共有ブラシ。 NULL ポインター。 SetFillBrushLookup で設定されたルックアップ キー。
SetFillBrushLocal と SetFillBrushLookup のいずれもまだ呼び出されていない。 NULL ポインター。 NULL ポインター。 NULL ポインター。
vtbl 66 HRESULT Clone(IXpsOMPath** path)

インターフェイスのディープ コピーを作成します。(IXpsOMPath.Clone)

pathIXpsOMPath**outインターフェイスのコピーへのポインター。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表に示すものが含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、XPS Document Errors を参照してください。

戻り値 説明
S_OK
 メソッドは成功しました。
E_OUTOFMEMORY
 この操作を実行するのに十分なメモリがありません。
E_POINTER
 path が NULL です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXpsOMPath "{37D38BB6-3EE9-4110-9312-14B194163337}"
#usecom global IXpsOMPath IID_IXpsOMPath "{}"
#comfunc global IXpsOMPath_GetGeometry                       30 sptr
#comfunc global IXpsOMPath_GetGeometryLocal                  31 sptr
#comfunc global IXpsOMPath_SetGeometryLocal                  32 sptr
#comfunc global IXpsOMPath_GetGeometryLookup                 33 var
#comfunc global IXpsOMPath_SetGeometryLookup                 34 wstr
#comfunc global IXpsOMPath_GetAccessibilityShortDescription  35 var
#comfunc global IXpsOMPath_SetAccessibilityShortDescription  36 wstr
#comfunc global IXpsOMPath_GetAccessibilityLongDescription   37 var
#comfunc global IXpsOMPath_SetAccessibilityLongDescription   38 wstr
#comfunc global IXpsOMPath_GetSnapsToPixels                  39 var
#comfunc global IXpsOMPath_SetSnapsToPixels                  40 int
#comfunc global IXpsOMPath_GetStrokeBrush                    41 sptr
#comfunc global IXpsOMPath_GetStrokeBrushLocal               42 sptr
#comfunc global IXpsOMPath_SetStrokeBrushLocal               43 sptr
#comfunc global IXpsOMPath_GetStrokeBrushLookup              44 var
#comfunc global IXpsOMPath_SetStrokeBrushLookup              45 wstr
#comfunc global IXpsOMPath_GetStrokeDashes                   46 sptr
#comfunc global IXpsOMPath_GetStrokeDashCap                  47 var
#comfunc global IXpsOMPath_SetStrokeDashCap                  48 int
#comfunc global IXpsOMPath_GetStrokeDashOffset               49 var
#comfunc global IXpsOMPath_SetStrokeDashOffset               50 float
#comfunc global IXpsOMPath_GetStrokeStartLineCap             51 var
#comfunc global IXpsOMPath_SetStrokeStartLineCap             52 int
#comfunc global IXpsOMPath_GetStrokeEndLineCap               53 var
#comfunc global IXpsOMPath_SetStrokeEndLineCap               54 int
#comfunc global IXpsOMPath_GetStrokeLineJoin                 55 var
#comfunc global IXpsOMPath_SetStrokeLineJoin                 56 int
#comfunc global IXpsOMPath_GetStrokeMiterLimit               57 var
#comfunc global IXpsOMPath_SetStrokeMiterLimit               58 float
#comfunc global IXpsOMPath_GetStrokeThickness                59 var
#comfunc global IXpsOMPath_SetStrokeThickness                60 float
#comfunc global IXpsOMPath_GetFillBrush                      61 sptr
#comfunc global IXpsOMPath_GetFillBrushLocal                 62 sptr
#comfunc global IXpsOMPath_SetFillBrushLocal                 63 sptr
#comfunc global IXpsOMPath_GetFillBrushLookup                64 var
#comfunc global IXpsOMPath_SetFillBrushLookup                65 wstr
#comfunc global IXpsOMPath_Clone                             66 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。