BOOKTEXT: Difference between revisions

Revision as of 18:49, 25 May 2024

Notebook data structure that contains text strings for notebook status lines and tabs. This data structure is used with the BKM_QUERYSTATUSLINETEXT and the BKM_QUERYTABTEXT messages only.

typedef struct _BOOKTEXT {
  PSZ       pString;  /*  Pointer to a string buffer. */
  ULONG     textLen;  /*  String length. */
} BOOKTEXT;

typedef   BOOKTEXT   * PBOOKTEXT ;

Fields

pString (PSZ)

Pointer to a string buffer.

Buffer in which the text string is to be placed. For the BKM_QUERYSTATUSLINETEXT message, this is the buffer in which the status line text is placed.

For the BKM_QUERYTABTEXT message, this is the buffer in which the tab text is placed.

textLen (ULONG): String length.; Length of the text string. For the BKM_QUERYSTATUSLINETEXT message, this is the length of the status line text string.; For the BKM_QUERYTABTEXT message, this is the length of the tab text string.

@@ Line 9: / Line 9: @@
 </PRE>
+==Fields==
+;pString (PSZ)
+:Pointer to a string buffer.
+:Buffer in which the text string is to be placed. For the BKM_QUERYSTATUSLINETEXT message, this is the buffer in which the status line text is placed.
+:For the BKM_QUERYTABTEXT message, this is the buffer in which the tab text is placed.
+;textLen (ULONG)
+:String length.
+:Length of the text string. For the BKM_QUERYSTATUSLINETEXT message, this is the length of the status line text string.
+:For the BKM_QUERYTABTEXT message, this is the length of the tab text string.
 [[Category: Data type]]