.\" ident @(#)codecvt_byname.3
.\" Standard Template Library
.\" $$RW_INSERT_HEADER "slyrs.man"
.TH codecvt_byname 3C++ "02 Apr 1998" "Rogue Wave Software" "-"
.ce2
Standard C++ Library   
Copyright 1998, Rogue Wave Software, Inc.   

.SH NAME

\f2codecvt_byname\fP

\ - A facet that includes code set conversion classification facilities based on the named locales.



.SH  SYNOPSIS


.br
#include <locale>
.br
template <class charT> class codecvt_byname;



.SH  DESCRIPTION


The_codecvt_byname template includes the same functionality as the codecvt_template, but specific to a particular named locale. For a description of the member functions of codecvt_byname, see the reference for codecvt._Only the constructor is described here.



.SH  INTERFACE



.br
template <class fromT, class toT, class stateT>
.br
class codecvt_byname : public codecvt<fromT, toT, stateT> {
.br
public:
.RE
.RS 1
explicit codecvt_byname(const char*, size_t refs = 0);
.RE
.RS 0
protected:
.RE
.RS 2
~codecvt_byname();  // virtual
.RE
.RS 1
virtual result do_out(stateT&,
.RE
.RS 23
const internT*, 
.br
const internT*, 
.br
const internT*&,
.br
externT*, externT*,
.br
externT*&) const;
.RE
.RS 1
virtual result do_in(stateT&,
.RE
.RS 22
const externT*, 
.br
const externT*, 
.br
const externT*&,
.br
internT*, internT*,
.br
internT*&) const;
.RE
.RS 1
virtual result do_unshift(stateT&,
.RE
.RS 27
externT*, externT*,
.br
externT*&) const;
.RE
.RS 0

.RE
.RS 1
virtual bool do_always_noconv() const throw();
.br
virtual int do_length(const stateT&, const externT*, 
.RE
.RS 23
const externT*, size_t max) const;
.RE
.RS 1
virtual int do_max_length() const throw();
.br
virtual int do_encoding() const throw();
.RE
.RS 0
};



.SH  CONSTRUCTORS



.br
explicit codecvt_byname(const char* name, size_t refs = 0); 
.RE
.RS 3


Construct a codecvt_byname facet. The facet provides codeset conversion relative to the named locale specified by the \f2name\fP argument. If the \f2refs\fP argument is \f20\fP, destruction of the object is delegated to the locale, or locales, containing it. This allows the user to ignore lifetime management issues. On the other hand, if \f2refs\fP is \f21\fP, the object must be explicitly deleted: the locale does not do so.

.RE



.SH  SEE ALSO


locale, facets, codecvt