ICity::get_InROM (Windows Embedded CE 6.0)

1/6/2010

The InROM property gets a Boolean value indicating whether the city is stored in ROM.

Syntax

HRESULT get_InROM(
   VARIANT_BOOL * pbInROM
);

Parameters

• pbInROM
  [out] Reference to the Boolean flag. VARIANT_TRUE if the city is stored in ROM and VARIANT_FALSE if the city is User-defined. For information about the VARIANT_BOOL type, see the union member of the PROPVARIANT structure.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

• S_OK
  The method completed successfully.

Remarks

The VARIANT_BOOL data type (also known as VT_BOOL) uses the value -1 to represent TRUE and 0 to represent FALSE. It is defined in the wtypes.h header file in the following manner:

typedef short VARIANT_BOOL;

A common programming error occurs when, for readability purposes, you want to set a VARIANT_BOOL value to TRUE or FALSE. You can achieve the same effect by using the aliases VARIANT_TRUE and VARIANT_FALSE, which are also defined in the wtypes.h header file.

#define VARIANT_TRUE  ((VARIANT_BOOL)0xffff)  // 0xffff is equivalent to -1.
#define VARIANT_FALSE ((VARIANT_BOOL)0)

Requirements

See Also

Reference

ICity
Pocket Outlook Object Model Interfaces

Other Resources

Pocket Outlook Object Model Enumerations