XLL+ Class Library (6.3)

CXlUserConverterBase<ElemType, XlNativeType>::GetTypeMessageId

Returns the ID of a resource string containing the extended type name

virtual unsigned int GetTypeMessageId(
   const CConvertParamsBase& params
) const;

Parameters

params

The conversion parameters supplied for the conversion. These include the argument name, and any extended type parameters set by the developer when the argument was specified.

Return Value

Returns 0 if no resource string is available. Returns the ID of a string in the application resource file if this is available.

Remarks

This method offers a localizable way of defining the name of an extended type. A string needs to be added to the resource file containing the name, e.g. "date". The method should return the resource ID of the string. If this method is not implemented then the default implementation will return 0.

Name resolution

If validation fails, and false is returned by one of the conversion methods, then the extended type name will be resolved using the first of the following methods that has been implemented in the concrete class.

  1. GetTypeMessageId
  2. GetTypeNameW
  3. GetTypeName

Requirements

Header: xlpconvert.h

See Also

CXlUserConverterBase<ElemType, XlNativeType> Class | CXlUserConverterBase<ElemType, XlNativeType> Methods