IHelpCatalog::OpenCatalog method

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

method OpenCatalog - Opens a catalog given a valid catalog directory path and list of prioritized languages for fallback.

Syntax

HRESULT OpenCatalog(
  [in]  BSTR path,
  [in]  SAFEARRAY(BSTR) prioritizedLocales
);

Parameters

  • path [in]
    Full path to the directory where the catalog partion files reside.

  • prioritizedLocales [in]
    Array of locale culture codes in priority order. This will drive which locale content is utilized first. (e.g. en-US, ja-JP, etc).

Return value

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

Remarks

Caller is required to call CloseCatalog when finished. Caller is required to have at least read access to the catalog path. PrioritizedLocales param should be non-null and populated with only valid locale culture codes.

Examples

Requirements

Minimum supported client

Windows Developer Preview

Minimum supported server

Windows Server Developer Preview

IDL

Windows.Help.Runtime.idl

See also

IHelpCatalog

 

 

Build date: 9/7/2011