nf-extsfns-idebugfaentrytags-getproperties.md

UID	title	description	old-location	tech.root	ms.date	keywords	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	f1_keywords	topic_type	api_type	api_location	api_name
NF:extsfns.IDebugFAEntryTags.GetProperties	IDebugFAEntryTags::GetProperties (extsfns.h)	The GetProperties method gets the name or description (or both) of a tag in a DebugFailureAnalysisTags object.	debugger\idebugfaentrytags_getproperties.htm	debugger	05/03/2018	IDebugFAEntryTags::GetProperties	GetProperties, GetProperties method [Windows Debugging], GetProperties method [Windows Debugging],IDebugFAEntryTags interface, IDebugFAEntryTags interface [Windows Debugging],GetProperties method, IDebugFAEntryTags.GetProperties, IDebugFAEntryTags::GetProperties, debugger.idebugfaentrytags_getproperties, extsfns/IDebugFAEntryTags::GetProperties	extsfns.h		Desktop															Windows		IDebugFAEntryTags::GetProperties extsfns/IDebugFAEntryTags::GetProperties	APIRef kbSyntax	COM	extsfns.h	IDebugFAEntryTags::GetProperties

IDebugFAEntryTags::GetProperties

-description

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

-parameters

-param Tag

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

-param Name [out]

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.

-param NameSize [in, out]

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.

 

-param Description [out]

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.

-param DescSize [in, out]

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.

 

-param Flags [out]

Reserved. Set this parameter to NULL.

-returns

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.

-see-also

IDebugFAEntryTags

IDebugFailureAnalysis2

SetProperties

Writing an Analysis Extension Plug-in to Extend !analyze

_EFN_Analyze