IHelpCatalogRead::GetLinkedAsset method

[This documentation is preliminary and is subject to change.]

method GetLinkedAsset - Returns a data stream containing the requested asset. Asset is identified by its package name and file path within the package within the currently open catalog.

Syntax

HRESULT GetLinkedAsset(
  [in]           IHelpCatalog *catalog,
  [in]           BSTR packageName,
  [in]           BSTR path,
  [in]           BSTR locale,
  [out, retval]  IUnknown **pRetVal
);

Parameters

  • catalog [in]
    Catalog interface instance to be used for the function.

  • packageName [in]
    Package name where the content can be found. Full path is not necessary as it can be deduced from the catalog. If the content is in a subdirectory then a relative path can be provided.

  • path [in]
    Path to the element in the package to be retrieved.

  • locale [in]
    TBD.

  • pRetVal [out, retval]
    Returns an IStream containing a byte stream of the requested item.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

TBD.

Examples

Requirements

Minimum supported client

Windows Developer Preview

Minimum supported server

Windows Server Developer Preview

IDL

Windows.Help.Runtime.idl

See also

IHelpCatalogRead

 

 

Build date: 9/7/2011