CA2AEX Class

 

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

This class is used by the string conversion macros CA2TEX and CT2AEX, and the typedef CA2A.

System_CAPS_ICON_important.jpg Important

This class and its members cannot be used in applications that execute in the Windows Runtime.

template <int t_nBufferLength = 128>
class CA2AEX

Parameters

t_nBufferLength
The size of the buffer used in the translation process. The default length is 128 bytes.

Public Constructors

NameDescription
CA2AEX::CA2AEXThe constructor.
CA2AEX::~CA2AEXThe destructor.

Public Operators

NameDescription
CA2AEX::operator LPSTRConversion operator.

Public Data Members

NameDescription
CA2AEX::m_pszThe data member that stores the source string.
CA2AEX::m_szBufferThe static buffer, used to store the converted string.

Unless extra functionality is required, use CA2TEX, CT2AEX, or CA2A in your own code.

This class contains a fixed-size static buffer which is used to store the result of the conversion. If the result is too large to fit into the static buffer, the class allocates memory using malloc, freeing the memory when the object goes out of scope. This ensures that, unlike text conversion macros available in previous versions of ATL, this class is safe to use in loops and that it won't overflow the stack.

If the class tries to allocate memory on the heap and fails, it will call AtlThrow with an argument of E_OUTOFMEMORY.

By default, the ATL conversion classes and macros use the current thread's ANSI code page for the conversion.

The following macros are based on this class:

  • CA2TEX

  • CT2AEX

The following typedef is based on this class:

  • CA2A

For a discussion of these text conversion macros, see ATL and MFC String Conversion Macros.

See ATL and MFC String Conversion Macros for an example of using these string conversion macros.

Header: atlconv.h

The constructor.

CA2AEX(LPCSTR psz, UINT nCodePage) throw(...);
CA2AEX(LPCSTR psz) throw(...);

Parameters

psz
The text string to be converted.

nCodePage
Unused in this class.

Remarks

Creates the buffer required for the translation.

The destructor.

~CA2AEX() throw();

Remarks

Frees the allocated buffer.

The data member that stores the source string.

LPSTR m_psz;

The static buffer, used to store the converted string.

char m_szBuffer[ t_nBufferLength];

Conversion operator.

operator LPSTR() const throw();

Return Value

Returns the text string as type LPSTR.

CA2CAEX Class
CA2WEX Class
CW2AEX Class
CW2CWEX Class
CW2WEX Class
Class Overview

Show: