Share via

IDebugCustomAttributeQuery2::GetCustomAttributeByName

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Obtains the custom attributes bytes given the name of the custom attribute.

Syntax

HRESULT GetCustomAttributeByName( 
   LPCOLESTR pszCustomAttributeName,
   BYTE*     ppBlob,
   DWORD*    pdwLen
);

int GetCustomAttributeByName(
   [In] string        pszCustomAttributeName,
   [In, Out] byte[]   ppBlob,
   [In, Out] ref uint pdwLen
);

Parameters

pszCustomAttributeName
[in] A string containing the name of the custom attribute to look for.

ppBlob
[in, out] An array that is filled in with the custom attribute bytes.

pdwLen
[in, out] Specifies the maximum number of bytes to return in the ppBlob array and returns the number of bytes actually written to the array.

Return Value

If successful, returns S_OK or returns S_FALSE if the custom attribute does not exist. Otherwise, returns an error code.

Remarks

Set the ppBlob parameter to a null value to return the number of attributes bytes available. Then allocate an array and pass that array in for the ppBlob parameter.

The attribute bytes represent the raw data of the custom attribute.

If the ppBlob and pdwLen parameters are set to a null value, this method can be used to determine if the custom attribute merely exists. An easier alternative, however, is to call the IsCustomAttributeDefined method.

See also