Edit

IDebugFAEntryTags::GetProperties method (extsfns.h)

  • Article

The GetProperties method gets the name or description (or both) of a tag in a DebugFailureAnalysisTags object.

Syntax

HRESULT GetProperties(
            FA_TAG Tag,
  [out]     PSTR   Name,
  [in, out] PULONG NameSize,
  [out]     PSTR   Description,
  [in, out] PULONG DescSize,
  [out]     PULONG Flags
);

Parameters

Tag

A value in the FA_TAG enumeration. This method gets the name or description (or both) of this tag.

[out] Name

A pointer to a buffer that receives a null-terminated string that is the name of the tag. If NameSize is less than the length of the tag's name, this method copies only NameSize bytes, including the NULL terminator, to this buffer.

[in, out] NameSize

On input, this parameter, specifies the size, in bytes, of the buffer pointed to by Name. On output, this parameter receives the size, in bytes, of the name of the tag. If the tag has no name, this parameter receives a value of 0.

Note  If Name is NULL, this parameter receives no information. You should either set both Name and NameSize to non-NULL values or set them both to NULL.
 

[out] Description

A pointer to a buffer that receives a null-terminated string that is the description of the tag. If DescSize is less than the length of the tag's description, this method copies only DescSize bytes, including the NULL terminator, to this buffer.

[in, out] DescSize

On input, this parameter, specifies the size, in bytes, of the buffer pointed to by Description. On output, this parameter receives the size, in bytes, of the description of the tag. If the tag has no description, this parameter receives a value of 0.

Note  If Description is NULL, this parameter receives no information. You should either set both Description and DescSize to non-NULL values or set them both to NULL.
 

[out] Flags

Reserved. Set this parameter to NULL.

Return value

The HRESULT values returned by this method are defined in winerror.h and strsafe.h. The values returned by this method include, but are not limited to the following:

Return code Description
S_OK
 This method successfully retrieved the requested name or description (or both), and no truncation of the requested string or strings was required.
STRSAFE_E_INSUFFICIENT_BUFFER
 This method retrieved the requested name or description (or both), but the name or description was truncated.
STRSAFE_E_INVALID_PARAMETER
The caller passed at least one invalid parameter.

Requirements

Requirement Value
Target Platform Desktop
Header extsfns.h

See also

IDebugFAEntryTags

IDebugFailureAnalysis2

SetProperties

Writing an Analysis Extension Plug-in to Extend !analyze

_EFN_Analyze