TerGetBulletInfo
Get the paragraph bullet/numbering information.
int TerGetBulletInfo(hWnd, QueryType, id, IsBullet, start, level, type,flags)
int TerGetBulletInfo2(hWnd, QueryType, id, IsBullet, start, level, type,ListOrId, flags)
int TerGetBulletInfo3(hWnd, QueryType, id, IsBullet, start, level, type,ListOrId, flags, ListText)
HWND hWnd; | The handle of the window to be accessed |
int QueryType; | This parameter can be set to one of the following values: |
PID_LINE: | Get the bullet information for the given line. |
PID_PARA: | Get the bullet information for the given paragraph id. |
PID_BULLET: | Get the bullet information for the given bullet id. |
PID_STYLE | Get the bullet information for the style id specified by the 'id' argument. |
long id; | The value for this parameter depends upon the value specified for the 'QueryType' parameter. When the 'QueryType' is set to PID_LINE, the 'id' parameter must contain a text line number. You can set the line number value to -1 to specify the current line. when the 'QueryType' is set to PID_PARA, then the 'id' parameter must contain a paragraph id. When the 'QueryType' is set to PID_BULLET, then the 'id' parameter must contain a valid bullet id. When the 'QueryType' is set to PID_STYLE, the 'id' parameter must contain a stylesheet id. |
LPINT IsBullet; | This pointer returns TRUE if the paragraph has bullets. It returns FALSE if the paragraph numbering is turned on. |
LPINT start; | This pointer returns the starting number when setting paragraph numbering is turned on. |
LPINT level; | This pointer returns the level number when paragraph numbering is turned on. |
LPINT type; | The pointer returns the symbol used for paragraph bullet/numbering. Please refer to the TerSetBulletEx function for the description of this variable. |
LPINT ListOrId; | The pointer to return the list override id if this bullet is created using the list table. A zero return value for this parameter indicates a regular bullet or a regular paragraph number. A non-zero value for this field indicates a bullet or number created using the list-mechanism. In this case, the values returned by the 'type' and 'ListText' are not applicable. Please use the TerGetListLevelInfo to retrieve the list information for this list. |
LPINT flags; | reserved for future use. |
LPBYTE ListText | List text. Please refer to the TerEditListLevel function for a description for this parameter. The ListText is valid only when ListOrId is returned as non-zero. |
Return Value: This function returns the current bullet id. A value of 0 indicates that the bullet/numbering is not turned on for the paragraph. A value of -1 indicates an error condition.