strbeginsfield

Function: strbeginsfield
Library: stringlib
Prototype: int strbeginsfield(char strarg, char fs, char strsrc)

Parameters

Parameter Type Description
strarg char * Pointer to comparison substring
strsrc char * Pointer to master string
fs char field separator

Return values

Value/Range Meaning
RETVNULLPTR -1 One or both of the provided string arguments contained a null pointer
RETVNOTFOUND -8 The beginning of the master string does not match the provided substring.
NON NEGATIVE The number of characters matched by the substring. Note that an empty substring matches an empty field.

Description

The strbeginsfieldfunction returns a non negative value if the comparison string matches the first field in the master string. This function is lettercase sensitive.

Filenames: strbeginsfield.c
Include files: ascnames.h, logicals.h, stringlib.h, retvals.h
Dependencies: mheaders

Developer Information

Proposer: Mark Hobley
Lead programmer: Mark Hobley
Documentation by:
Manual page by:

Test Status

Lead test planner:
Lead test developer:
Test sign off:
Test plan: PENDING
Test programs: