Export (0) Print
Expand All

StartsWithString

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The StartsWithString function indicates whether a specified source string begins with a specified search string.

Syntax

bool StartsWithString(
  string sourceString,
  string searchString,
  bool ignoreCase
);

Parameters

sourceString

Specifies the source string that the function examines.

searchString

Specifies the string to search for at the beginning of the string specified by sourceString.

ignoreCase

Specifies whether the search is case-sensitive or case-insensitive. If false, the search is case-sensitive. If true, the search is case-insensitive.

Return Values

Returns true if the string specified by sourceString begins with the string specified by searchString. Returns false if either the sourceString does not begin with searchString, or if searchString is longer than sourceString.

Example Code

The following code example assumes that headerString contains a SIP URI that includes a parameter named "user". The example code determines whether the value of the user parameter begins with "phone", and is case-insensitive.

StartsWithString(GetParameterValue(headerString, "user"), "phone", "true")
Show:
© 2014 Microsoft