Retrieve a string representation of the code completion string, which is mainly useful for debugging.
A "string" used to describe how code completion can be performed for an entity.
A code completion string typically shows how a particular entity can be used. For example, the code completion string for a function would show the syntax to call it, including the parentheses, placeholders for the arguments, etc.
The different kinds of "chunks" that can occur within a code completion string.
Enumerator
CK_TypedText
The piece of text that the user is expected to type to match the code-completion string, typically a keyword or the name of a declarator or macro.
CK_Text
A piece of text that should be placed in the buffer, e.g., parentheses or a comma in a function call.
CK_Optional
A code completion string that is entirely optional. For example, an optional code completion string that describes the default arguments in a function call.
CK_Placeholder
A string that acts as a placeholder for, e.g., a function call argument.
CK_Informative
A piece of text that describes something about the result but should not be inserted into the buffer.
CK_ResultType
A piece of text that describes the type of an entity or, for functions and methods, the return type.
CK_CurrentParameter
A piece of text that describes the parameter that corresponds to the code-completion location within a function call, message send, macro invocation, etc.
CK_LeftParen
A left parenthesis ('(').
CK_RightParen
A right parenthesis (')').
CK_LeftBracket
A left bracket ('[').
CK_RightBracket
A right bracket (']').
CK_LeftBrace
A left brace ('{').
CK_RightBrace
A right brace ('}').
CK_LeftAngle
A left angle bracket ('<').
CK_RightAngle
A right angle bracket ('>').
CK_Comma
A comma separator (',').
CK_Colon
A colon (':').
CK_SemiColon
A semicolon (';').
CK_Equal
An '=' sign.
CK_HorizontalSpace
Horizontal whitespace (' ').
CK_VerticalSpace
Vertical whitespace ('\n' or '\r\n', depending on the platform).