Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

Table of Contents

OpenEdge.Logging.LogMessage

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: January 15, 2026
  • 5 minute read
    • OpenEdge
    • Version 12.8
    • Documentation
Namespace: OpenEdge.Logging
Type: Class LogMessage
Parent Classes:
Progress.Lang.Object
OpenEdge.Logging.LogMessage

Inherits: Progress.Lang.Object

Copyright (c) 2016, 2018-2019, 2021-2022 by Progress Software Corporation. All rights reserved.
File:LogMessage
Purpose:A data container/value object for a message to be logged, including
substitution args
Author(s):pjudge
Created:Wed Nov 16 12:01:34 EST 2016
/* (mandatory) The group for this log message



Method Summary
  Options Name Purpose
  AddContext (character, Object) /* Adds context values to this message. @param character (required) The context key name @param P.L.Object A context value */
  LOGICAL AddToken (Token) /* Adds a token to the message's set of tokens. @param Token A Token to add @return logical Returns TRUE if the token was added to the Set; FALSE otherwise */
  LOGICAL AddTokens (Token[]) /* Adds one or more tokens to the message's set of tokens. @param Token[] An array of tokens. May be indeterminate @return logical Returns TRUE if at least one token was added to the Set; FALSE otherwise */
  Progress.Lang.Object GetContext (character) /* Returns a context value for a given key. @param character (required) The context key name @return P.L.Object A context value. Returns NULL if no context exists */

Constructor Summary
  Options Name Purpose
  LogMessage (character, character) /* Constructor @param character The message group @param character the message text */
  LogMessage (character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument (context) */
  LogMessage (character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument */
  LogMessage (character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument */
  LogMessage (character, character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument @param character The fourth argument */
  LogMessage (character, character, character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument @param character The fourth argument @param character The fifth argument */
  LogMessage (character, character, character, character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument @param character The fourth argument @param character The fifth argument @param character The sixth argument */
  LogMessage (character, character, character, character, character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument @param character The fourth argument @param character The fifth argument @param character The sixth argument @param character The seventh argument */
  LogMessage (character, character, character, character, character, character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument @param character The fourth argument @param character The fifth argument @param character The sixth argument @param character The seventh argument @param character The eighth argument */
  LogMessage (character, character, character, character, character, character, character, character, character, character, character) /* Constructor @param character The message group @param character The message base text @param character The first argument @param character The second argument @param character The third argument @param character The fourth argument @param character The fifth argument @param character The sixth argument @param character The seventh argument @param character The eighth argument @param character The ninth argument */
  LogMessage (character, character, character[]) /* Constructor @param character The message group @param character the message base @param character[] A set of character arguments (context) */

Property Summary
  Options Name Purpose
  CHARACTER BaseText
  CHARACTER GroupName
  CHARACTER Message
  ISet &ltToken> Tokens


Method Detail
Top

AddContext (character, Object)

/* Adds context values to this message.
Parameters:
pKey CHARACTER
 
pContext Progress.Lang.Object
 
Top

LOGICAL AddToken (Token)

/* Adds a token to the message's set of tokens.
Parameters:
pToken OpenEdge.Core.Util.Token
 
Returns LOGICAL
  logical Returns TRUE if the token was added to the Set; FALSE otherwise
Top

LOGICAL AddTokens (Token[])

/* Adds one or more tokens to the message's set of tokens.
Parameters:
pTokens OpenEdge.Core.Util.Token
 
Returns LOGICAL
  logical Returns TRUE if at least one token was added to the Set; FALSE otherwise
Top

Progress.Lang.Object GetContext (character)

/* Returns a context value for a given key.
Parameters:
pKey CHARACTER
 
Returns Progress.Lang.Object
  P.L.Object A context value. Returns NULL if no context exists


Constructor Detail
Top

LogMessage (character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessage CHARACTER
 
Top

LogMessage (character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
Top

LogMessage (character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
Top

LogMessage (character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
Top

LogMessage (character, character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
pcArg4 CHARACTER
 
Top

LogMessage (character, character, character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
pcArg4 CHARACTER
 
pcArg5 CHARACTER
 
Top

LogMessage (character, character, character, character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
pcArg4 CHARACTER
 
pcArg5 CHARACTER
 
pcArg6 CHARACTER
 
Top

LogMessage (character, character, character, character, character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
pcArg4 CHARACTER
 
pcArg5 CHARACTER
 
pcArg6 CHARACTER
 
pcArg7 CHARACTER
 
Top

LogMessage (character, character, character, character, character, character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
pcArg4 CHARACTER
 
pcArg5 CHARACTER
 
pcArg6 CHARACTER
 
pcArg7 CHARACTER
 
pcArg8 CHARACTER
 
Top

LogMessage (character, character, character, character, character, character, character, character, character, character, character)

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArg1 CHARACTER
 
pcArg2 CHARACTER
 
pcArg3 CHARACTER
 
pcArg4 CHARACTER
 
pcArg5 CHARACTER
 
pcArg6 CHARACTER
 
pcArg7 CHARACTER
 
pcArg8 CHARACTER
 
pcArg9 CHARACTER
 
Top

LogMessage (character, character, character[])

/* Constructor
Parameters:
pcGroup CHARACTER
 
pcMessageBase CHARACTER
 
pcArgs CHARACTER
 


Property Detail
Top

CHARACTER BaseText

Returns CHARACTER
 
Top

CHARACTER GroupName

Returns CHARACTER
 
Top

CHARACTER Message

Returns CHARACTER
 
Top

ISet &ltToken> Tokens

Returns ISet &ltToken>
 


TitleResults for “How to create a CRG?”Also Available inAlert