RasSetEntryProperties

A version of this page is also available for

Windows Embedded CE 6.0 R3

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, RasSetEntryProperties modifies the properties of that entry.

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

• lpbEntry
  Pointer to a RASENTRY structure that that contains the new connection data to be associated with the phone-book entry specified by the szEntry parameter.

  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 dwAlternateOffset member of the RASENTRY structure that contains the offset to the first string.

• dwEntrySize
  Specifies the size, in bytes, of the buffer specified by the lpRasEntry parameter.

• 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 lineGetDevConfig function in the Win32 Telephony (TAPI) Programmer's Reference.

• dwSize
  Specifies the size, in bytes, of the lpb buffer.

Return Value

Zero indicates success. ERROR_BUFFER_INVALID indicates that the address or buffer specified by lpbEntry is 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 lpb and dwSize parameters are ignored and should be set to NULL.

For Windows CE 2.0 and later, device configuration information can be set by using lpb and dwSize parameters.

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

Requirements

See Also

Reference

RasGetEntryProperties
RasValidateEntryName
RASENTRY