EDCS Reference Manual
Functions
EDCS IsStringEmpty
extern EDCS_Status_Code
EDCS_IsStringEmpty
(
constEDCS_String *string_ptr, (notes)
EDCS_Boolean *result_out_ptr (notes)
);

Definition

Checks whether the given EDCS_String is an "empty" string.

NOTE: Do NOT use a pointer comparison on the string value with edcs_empty_string; a string is empty if it is of length zero, not just if it equals edcs_empty_string.


Returns

EDCS_SC_SUCCESS and *result_out_ptr is set to the appropriate value, if valid parameters were passed in.
EDCS_SC_NULL_REQUIRED_PARAMETER and no changes are made, if string_ptr or result_out_ptr is NULL.
EDCS_SC_OTHER_FAILURE and *result_out_ptr is set to EDCS_FALSE, if string_ptr->string_value is NULL.


Parameters Notes


string_ptr

 pointer to the EDCS_String being checked

result_out_ptr

 pointer to a variable in the user's memory space where
    the result will be stored


Prev: EDCS_IsStateApplicable. Next: EDCS_LabelToEACode. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS