helpdlog.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once
#ifndef __helpdlogH__
#define __helpdlogH__

#define HELPRSC_ARTICLE         0x48456172    /* 'HEar' */
#define HELPRSC_COMMAND         0x4845636d    /* 'HEcm' */
#define HELPRSC_INDEX           0x48456478    /* 'HEdx' */
#define HELPRSC_TOPIC           0x48457470    /* 'HEtp' */

#define RSCID_TASKIDLIST        0x5441534B    /* 'TASK' */
#define RSCID_TITLELIST         0x5449544C    /* 'TITL' */

typedef struct helpCommand
    {
    UInt32      messageListIndex;
    UInt32      articleId;
    } HelpCommand;

typedef HelpCommand    HelpTopic;

#ifdef resource
resourceclass HelpTopic         HELPRSC_TOPIC;
resourceclass HelpCommand       HELPRSC_COMMAND;
#endif

#ifdef resource
typedef struct helpIndex
    {
    UInt32      type;
    UInt32      articleId;
    } HelpIndex [];
resourceclass HelpIndex         HELPRSC_INDEX;
#else
typedef struct helpIndex
    {
    long        count;
    struct
        {
        UInt32  type;
        UInt32  articleId;
        } link[1];
    } HelpIndex;
#endif


typedef struct xReference
    {
    UInt32      type;
    UInt32      articleId;
    int         taskIndex;
    } XReference;

typedef struct helpArticle
    {
#ifdef resource
    XReference      subtopic[];
    XReference      seeAlso[];
    WChar           text[];
#else
    UInt32          subtopicCount;
    XReference      subtopic[1];
    UInt32          seeAlsoCount;
    XReference      seeAlso[1];
    long            textLength;
    WChar           text[1];
#endif
    } HelpArticle;

#ifdef resource
resourceclass HelpArticle       HELPRSC_ARTICLE;
#endif

#endif