Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function changes the connection information for an entry in the phone book or creates a new phone-book entry.

Syntax 

DWORD RasSetEntryProperties(
  LPWSTR 
lpszPhoneBook, 
  LPWSTR 
szEntry, 
  LPRASENTRY 
lpbEntry, 
  DWORD
 dwEntrySize, 
  LPBYTE 
lpb, 
  DWORD 
dwSize 
);

Parameters

lpszPhoneBook

This parameter is ignored and should be set to NULL. Phonebook entries are stored in the registry rather than in a phone-book file.

szEntry

Pointer to a null-terminated string that contains an entry name.

If the entry name matches an existing entry, RasSetEntryPropertiesmodifies the properties of that entry.

If the entry name does not match an existing entry, RasSetEntryPropertiescreates a new phone-book entry. For new entries, call the RasValidateEntryNamefunction to validate the entry name before calling RasSetEntryProperties.

lpbEntry

Pointer to a RASENTRYstructure that that contains the new connection data to be associated with the phone-book entry specified by the szEntryparameter.

The structure might be followed by an array of null-terminated alternate phone number strings. The last string is terminated by two consecutive null characters. The dwAlternateOffsetmember of the RASENTRYstructure that contains the offset to the first string.

dwEntrySize

Specifies the size, in bytes, of the buffer specified by the lpRasEntryparameter.

lpb

Pointer to a buffer that contains device-specific configuration information. This is opaque TAPI device configuration information. For more information about TAPI device configuration, see the lineGetDevConfigfunction in the Win32 Telephony (TAPI) Programmer's Reference.

dwSize

Specifies the size, in bytes, of the lpbbuffer.

Return Value

Zero indicates success. ERROR_BUFFER_INVALID indicates that the address or buffer specified by lpbEntryis invalid. ERROR_CANNOT_OPEN_PHONEBOOK indicates that the phone book is corrupted or missing components.

Include Raserror.h for definitions of the RAS error codes.

Remarks

For Windows CE 1.0 and 1.01, the lpband dwSizeparameters are ignored and should be set to NULL.

For Windows CE 2.0 and later, device configuration information can be set by using lpband dwSizeparameters.

Windows Embedded CE does not use the alternate phone number list.

Requirements

Header ras.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also