StringInit

Inicializa una cadena con símbolos especificados y proporciona la longitud especificada de una cadena.

bool  StringInit(
   string&   string_var,       // cadena para inicialización
   int       new_len=0,        // longitud necesaria después de inicialización
   ushort    character=0       // símbolo con el que se llena la cadena
   );

Parámetros

string_var

[in][out]  Cadena que tiene que ser inicializada o deinicializada.

new_len=0

[in]  Longitud de la cadena después de inicialización. Si la longitud=0, la cadena se deinicializa, es decir, el buffer de la cadena se limpia y la dirección del buffer se pone a cero.

character=0

[in]  Símbolo para llenar la cadena.

Valor devuelto

En caso de éxito devuelve true, de lo contrario devuelve false. Para obtener el código de error hay que llamar a la función GetLastError().

Nota

Si character=0 y la longitud new_len>0, entonces el buffer de la cadena con longitud indicada será distribuido y llenado con ceros. La longitud de la cadena será igual a cero porque el buffer entero está llenado con terminadores de la cadena.

Ejemplo:

void OnStart()
  {
//---
   string str;
   StringInit(str,200,0);
   Print("str = ",str,": StringBufferLen(str) = ",
         StringBufferLen(str),"  StringLen(str) = ",StringLen(str));
  }
/*  Resultado
str = : StringBufferLen(str) = 200   StringLen(str) = 0
*/

Véase también

StringBufferLen, StringLen